-
Notifications
You must be signed in to change notification settings - Fork 21
Branching strategy selection, cumulative authoring, ++ #1445
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
Conversation
Co-authored-by: Jan Calanog <[email protected]>
docs/contribute/cumulative-docs.md
Outdated
## Configure a space-level landing page [space-landing-page] | ||
```{applies_to} | ||
stack: ga | ||
serverless: unavailable | ||
``` | ||
```` | ||
% I think we wanted to not specify stack here |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@florent-leborgne @colleenmcginnis I think we talked about only having the serverless: unavailable
tag here. wyt
I can extend to the areas that follow the same rule based on what we decide (couple of additional instances in this PR)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am quite unsettled on this. Let's choose one approach and revisit later if we get feedback on it. No strong opinion at the moment besides trying to keep the badging minimal
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I cut the stack tags for now but they're easy to put back in
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for getting this started @shainaraskas! I was only able to get through the pages in the Contribute
section so far. I tried to scope my review to the accuracy and clarity of information. I didn't leave comments related to style or grammar.
I might have introduced some scope creep in the pages other than deployment model and cumulative authoring 🙈 but it was helpful to read through all the content together to get a full picture. I'll open separate issues for those comments so this PR doesn't become unmanageable.
Co-authored-by: Colleen McGinnis <[email protected]>
…ilder into more-guidance-versioning
…ilder into more-guidance-versioning
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good! I'd say any more work to be done can be done in a follow up.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Niceeee
This PR makes information related to our branching strategies and cumulative authoring approach more visible and does some accuracy edits
Key changes
Introduce hints about deployment models ("Branches in V3") and refactor cumulative documentation callout.
Pages refactored to pivot from stack version to platform, plus minor changes
Cleanup, minor changes, warnings
TODO (future PRs)
Central version config info in the cumulative docs / deployment models / applies syntax docs(done)/versions/
pages