Document Enterprise Portal service account automation#4249
Document Enterprise Portal service account automation#4249NoaheCampbell wants to merge 4 commits into
Conversation
✅ Deploy Preview for replicated-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for replicated-docs-upgrade ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
github-actions
Bot
added
type::docs
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
|
||
| You can customize the text around these components like any other MDX content page. For example, you can add prerequisites, link to your support process, or include notes about how your customers should request service account access. | ||
|
|
||
| The `<APIReference />` component also supports a `description` prop. Use it to replace the default intro text above the endpoint reference: |
There was a problem hiding this comment.
[Replicated.PositionalLanguage] Avoid spacial and directional language like 'above'. Instead, use 'on this page', 'the following', or link to the section.
| /> | ||
| ``` | ||
|
|
||
| The `<HeadlessWorkflowGuide />` component does not currently support props. It renders the default example workflow from the Enterprise Portal template. To customize that page, edit the surrounding MDX content, move the component to a different page, or remove the component and write your own workflow. |
There was a problem hiding this comment.
[Replicated.Timeless] Avoid temporal words like 'currently'.
|
Readability nit - The intro section has 5 consecutive single-sentence paragraphs that read a bit choppy. Combining a couple would flow better. I also had the 🤖 review the docs against the actual backend routes, Next.js proxy layer, MDX component registry, and content template repo, and it flagged the following things. Can you please take a look at these concerns it raised.
The swagger spec in #10160 documents GET /api/v1/install-options/{id}/update-instructions as a service-account endpoint, but the route isn't registered in apiEPServiceAccountGroup (daemon.go lines 352-367), and there's no Next.js proxy route for it. It only exists in the browser-session-authenticated group (daemon.go line 419). #10160 doesn't modify daemon.go. This means the component will render an update-instructions endpoint that returns 401 when a customer tries it with an SA token. The docs PR references "install and update instructions" in a few places. Either the route needs to be added to the SA group + proxy layer in #10160, or the update-instructions references should come out of both PRs until that's wired up.
The template repo (replicatedhq/enterprise-portal-content) has no automation pages, no usage, and no usage. #10160 doesn't update the template repo either. Vendors would need to manually add the pages using the instructions on this docs page. The docs page should either say "you can add" instead of "the template includes", or the template repo needs a follow-up PR to add the default pages. |
|
|
||
| This topic describes how to add service account automation docs to the new Enterprise Portal. Service account automation lets your customers call Enterprise Portal API endpoints from CI/CD systems or other scripts. | ||
|
|
||
| Customers can use these endpoints to create install profiles, get structured install and update instructions, and download referenced artifacts. The Enterprise Portal content template includes components that render customer-facing API documentation inside the customer's portal, so you can document automation without maintaining endpoint tables or example workflows by hand. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
Match the existing EP section pattern (Connect, Customize, Manage, Enable) instead of a noun phrase. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2 participants
Documents Enterprise Portal service account automation for the new Enterprise Portal.
Adds a new Service Account Automation page that explains why vendors should include the built-in automation docs in their Enterprise Portal content repo, how the default API reference and workflow guide pages work, and what customers can use them for.
The new page covers:
Also updates the new Enterprise Portal overview and use pages to mention service account automation.