Skip to content

EP v2 docs: reduce content-repo onboarding confusion#4282

Merged
AmberAlston merged 2 commits into
mainfrom
ep-v2-onboarding-docs
Jul 20, 2026
Merged

EP v2 docs: reduce content-repo onboarding confusion#4282
AmberAlston merged 2 commits into
mainfrom
ep-v2-onboarding-docs

Conversation

@AmberAlston

@AmberAlston AmberAlston commented Jul 20, 2026

Copy link
Copy Markdown
Member

Preview links

What

Documentation improvements targeting recurring points of confusion for vendors setting up an Enterprise Portal v2 content repo.

  • Access / Local preview: spell out the /path/to/repo and <app-slug> placeholders, add a filled-in example, and document the content path does not exist error (vendors run the example command verbatim).
  • Troubleshooting: add "Updated main but customers still see old content" (nearest-lower-semver + stray version branch) and "Local preview: content path does not exist".
  • Connect a Git Repo / Applying an update: add the actual git workflow for adopting template updates (cloned repos share no history, so git pull/merge don't work — add upstream remote, git checkout upstream/main -- <files>); clarify the banner is an informational feed and Mark reviewed only clears it.

Why

Based on real onboarding friction: placeholder commands run literally, main synced but a stray version branch still serving old content, and the template-update flow assuming knowledge of how to bring changes into a diverged repo.

There are a few small UI improvements stories created as well, but this handles the docs side

- Access/Local preview: make the /path/to/repo and <app-slug> placeholders
  explicit, add a filled-in example, and document the 'content path does not
  exist' error
- Troubleshooting: add 'Updated main but customers still see old content'
  (nearest-lower-semver stray branch) and the preview path-placeholder error
- Connect a Git Repo: add the actual git workflow for adopting template
  updates (no shared history -> upstream remote + checkout), clarify the
  banner is an informational feed and Mark reviewed only clears it
- Manage Content Versions: add an opinionated default (main-only unless docs
  diverge; avoid stray version branches)

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@AmberAlston
AmberAlston requested a review from a team as a code owner July 20, 2026 19:41
@netlify

netlify Bot commented Jul 20, 2026

Copy link
Copy Markdown

Deploy Preview for replicated-docs-upgrade ready!

Name Link
🔨 Latest commit 681d9b7
🔍 Latest deploy log https://app.netlify.com/projects/replicated-docs-upgrade/deploys/6a5e8117efa3630008c759d5
😎 Deploy Preview https://deploy-preview-4282--replicated-docs-upgrade.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@netlify

netlify Bot commented Jul 20, 2026

Copy link
Copy Markdown

Deploy Preview for replicated-docs ready!

Name Link
🔨 Latest commit 681d9b7
🔍 Latest deploy log https://app.netlify.com/projects/replicated-docs/deploys/6a5e811757004c0008fb221d
😎 Deploy Preview https://deploy-preview-4282--replicated-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@github-actions github-actions Bot added type::docs Improvements or additions to documentation type::feature labels Jul 20, 2026
Comment thread docs/vendor/enterprise-portal-v2-access.mdx
Comment thread docs/vendor/enterprise-portal-v2-access.mdx
Comment thread docs/vendor/enterprise-portal-v2-connect-repo.mdx
Comment thread docs/vendor/enterprise-portal-v2-connect-repo.mdx
Comment thread docs/vendor/enterprise-portal-v2-connect-repo.mdx
Comment thread docs/vendor/enterprise-portal-v2-troubleshooting.mdx
Comment thread docs/vendor/enterprise-portal-v2-troubleshooting.mdx
Comment thread docs/vendor/enterprise-portal-v2-troubleshooting.mdx
Comment thread docs/vendor/enterprise-portal-v2-troubleshooting.mdx
Comment thread docs/vendor/enterprise-portal-v2-versioned-docs.mdx Outdated
…d-docs note

- Access: break the preview command and example across lines with backslash
  continuation (matches the curl pattern in enterprise-portal-v2-vendor-api-automation)
  so the full command shows on narrow screens
- Revert the added note on Manage Content Versions per review

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@AmberAlston
AmberAlston merged commit f86a5d5 into main Jul 20, 2026
5 checks passed
@AmberAlston
AmberAlston deleted the ep-v2-onboarding-docs branch July 20, 2026 20:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type::docs Improvements or additions to documentation type::feature

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants