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

sample scaffold subcommand, wip #1

Merged
merged 2 commits into from
Aug 15, 2023

Conversation

sblair-metrostar
Copy link

Reference Issues or PRs

Sample based on ongoing plugin extension included in PR 1833

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): Sample, work in progress plugin (for review/feedback)

Testing

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

Documentation

README.md

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?

For review and feedback only. This is a wip effort to get something working with the new plugin system and mess with some of the capabilities such as nested subcommands, configuration schema extension, etc.... Only the nebari scaffold plugin subcommand functionality is implemented at this time, and only a barebones template that can be extended upon as we develop standardized patterns we want to baseline. Planning to build out the stage variant once we have a working stage plugin to mirror.

Copy link
Member

@costrouc costrouc left a comment

Choose a reason for hiding this comment

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

@sblair-metrostar I was able to run this locally. Also nice to have a template like command for nebari.

Could you add this to the README.md at the root level subcommands? So it is easy to find.

@costrouc costrouc marked this pull request as ready for review August 15, 2023 12:11
@costrouc costrouc merged commit ed80ff9 into nebari-dev:main Aug 15, 2023
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.

2 participants