Skip to content

update docs from feedback and minor edits for clarity #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 6, 2025

Conversation

vigneshrajsb
Copy link
Contributor

Fixes

  • Updates screensnips for onboarding flow
  • Fix examples for template variables
  • Callout certificate validation delays before setting up github app
  • Updates helm install step command

Proposed Changes

  • Change

Read about referenced issues here. Replace words with this Pull Request's context.

@vigneshrajsb vigneshrajsb requested a review from a team as a code owner June 6, 2025 18:53
@vigneshrajsb vigneshrajsb requested review from Copilot and a team and removed request for a team June 6, 2025 18:53
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR refreshes documentation examples and clarifies setup steps based on feedback.

  • Updated example subdomains in Mission Control docs
  • Switched Helm install to helm upgrade -i and added certificate readiness guidance
  • Standardized template-variable formatting, added “no spaces” note

Reviewed Changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
src/pages/docs/tips/using-mission-control.mdx Updated example UUID in the override section
src/pages/docs/setup/install-lifecycle.mdx Replaced helm install with helm upgrade -i, added certificate check
src/pages/docs/features/template-variables.mdx Clarified that service names must have no spaces
src/lib/static/blogcontent/blogcontent.ts Synced blogcontent bodies with MDX changes; updated formatting in strings
src/lib/static/blogcontent/blogcontent.json Updated JSON version to match MDX and TS changes
src/components/home/main/index.tsx Ensured a space is rendered after “Introducing” in JSX
Comments suppressed due to low confidence (2)

src/lib/static/blogcontent/blogcontent.ts:37

  • The placeholder between the backticks is empty. Update it to show the intended format, for example {{{<service>_internalHostname}}}.
For service-specific variables, replace `` with the actual service name.

src/lib/static/blogcontent/blogcontent.json:35

  • The placeholder between the backticks is empty. Update it to show the intended format, for example {{{<service>_internalHostname}}}.
For service-specific variables, replace `` with the actual service name.

Copy link
Contributor

@yowainwright yowainwright left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🚀

@vmelikyan vmelikyan merged commit a1cebfd into GoodRxOSS:main Jun 6, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants