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 extension-system docs #352

Merged
merged 4 commits into from
Aug 17, 2023
Merged

Add extension-system docs #352

merged 4 commits into from
Aug 17, 2023

Conversation

costrouc
Copy link
Member

Reference Issues or PRs

Closes #349

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?

@netlify
Copy link

netlify bot commented Aug 15, 2023

Deploy Preview for nebari-docs ready!

Name Link
🔨 Latest commit 09368ea
🔍 Latest deploy log https://app.netlify.com/sites/nebari-docs/deploys/64db6cc3455cde000889b9d1
😎 Deploy Preview https://deploy-preview-352--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.

@pavithraes pavithraes added type: enhancement 💅🏼 New feature or request status: in progress 🏗 This task is currently being worked on labels Aug 15, 2023
@costrouc costrouc added needs: review 👀 This PR is complete and ready for reviewing status: in review 👀 This PR is currently being reviewed by the team and removed status: in progress 🏗 This task is currently being worked on labels Aug 15, 2023
@costrouc costrouc changed the title [WIP] Adding initial commit for extension-system docs Adding initial commit for extension-system docs Aug 15, 2023
Copy link
Member

@iameskild iameskild left a comment

Choose a reason for hiding this comment

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

My one question is whether this belongs in the how-to, developer, or architecture section? @pavithraes do you have a opinion one way or another?

Other than that, awesome work! Thanks @costrouc!

@costrouc
Copy link
Member Author

@iameskild currently I have it in the howtos. @pavithraes is this the right one?

@pavithraes
Copy link
Member

Thanks, @costrouc! I think it fits well in the how-to guide. :)

@pavithraes pavithraes changed the title Adding initial commit for extension-system docs Add extension-system docs Aug 17, 2023
@pavithraes pavithraes added status: approved 💪🏾 This PR has been reviewed and approved for merge and removed status: in review 👀 This PR is currently being reviewed by the team needs: review 👀 This PR is complete and ready for reviewing labels Aug 17, 2023
@pavithraes pavithraes merged commit 6dd4f44 into main Aug 17, 2023
5 checks passed
@pavithraes pavithraes deleted the doc-extension-system branch August 17, 2023 14:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: approved 💪🏾 This PR has been reviewed and approved for merge type: enhancement 💅🏼 New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] - Using the Extension Mechanism
3 participants