Skip to content
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

add intitial healthcheck docs #515

Merged
merged 11 commits into from
Sep 16, 2024
Merged

add intitial healthcheck docs #515

merged 11 commits into from
Sep 16, 2024

Conversation

dcmcand
Copy link
Contributor

@dcmcand dcmcand commented Sep 5, 2024

Reference Issues or PRs

What does this implement/fix?

Put a x in the boxes that apply

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds a feature)
  • Breaking change (fix or feature that would cause existing features not to work as expected)
  • Documentation Update
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no API changes)
  • Build related changes
  • Other (please describe):

Testing

  • Did you test the pull request locally?
  • Did you add new tests?

Documentation

Access-centered content checklist

Text styling

  • The content is written with plain language (where relevant).
  • If there are headers, they use the proper header tags (with only one level-one header: H1 or # in markdown).
  • All links describe where they link to (for example, check the Nebari website).
  • This content adheres to the Nebari style guides.

Non-text content

  • All content is represented as text (for example, images need alt text, and videos need captions or descriptive transcripts).
  • If there are emojis, there are not more than three in a row.
  • Don't use flashing GIFs or videos.
  • If the content were to be read as plain text, it still makes sense, and no information is missing.

Any other comments?

Copy link

netlify bot commented Sep 5, 2024

Deploy Preview for nebari-docs ready!

Name Link
🔨 Latest commit 3673cc5
🔍 Latest deploy log https://app.netlify.com/sites/nebari-docs/deploys/66e84733fa6dae000840ac20
😎 Deploy Preview https://deploy-preview-515--nebari-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 site configuration.

@viniciusdc
Copy link
Contributor

Hi @dcmcand thanks for the PR, can you address the failing test and also for the page to show up in the final doc you also need to include it in the https://github.com/nebari-dev/nebari-docs/blob/main/docs/sidebars.js#L55

docs/docs/how-tos/setup-healthcheck.md Show resolved Hide resolved
docs/docs/how-tos/setup-healthcheck.md Outdated Show resolved Hide resolved
docs/docs/how-tos/setup-healthcheck.md Outdated Show resolved Hide resolved
docs/docs/how-tos/setup-healthcheck.md Show resolved Hide resolved
@viniciusdc
Copy link
Contributor

@dcmcand can you move this example to a code block?
image


:::

## Summary of available healthchecks
Copy link
Contributor

Choose a reason for hiding this comment

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

@dcmcand I added a table of available healthchecks to explain what each one does. Can you review and make sure this is correct?

Also, apologies for the unreadable format - yarn formatting added tons of spaces which makes it hard to read in md format.

@dcmcand dcmcand merged commit 51c0e62 into main Sep 16, 2024
6 checks passed
@dcmcand dcmcand deleted the healthcheck-docs branch September 16, 2024 15:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done 💪🏾
Status: Done 💪🏾
Development

Successfully merging this pull request may close these issues.

3 participants