Skip to content

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

Merged
merged 28 commits into from
Jul 2, 2025

Conversation

shainaraskas
Copy link
Contributor

@shainaraskas shainaraskas commented Jun 25, 2025

This PR makes information related to our branching strategies and cumulative authoring approach more visible and does some accuracy edits

Key changes

Page Changes
✏️ Contribute overview Update instructions so they're not stack version centric, but instead docs platform centric. Provide clearer hints about finding where your docs are published.

Introduce hints about deployment models ("Branches in V3") and refactor cumulative documentation callout.
🆕 Write cumulative documentation Single page that combines an explanation of the cumulative approach with tagging examples
🆕 Choose a branching strategyl Add decision-making guidance + workflow example for the two branching strategies, connect to the config instructions
🚚 Content sources Moved the config page for content sources out of the migration docs and into the primary config docs (we might want to do this with more key docs)
✏️ Migration: new versioning Pulled out content sources, added basic info about tag processing and deployment models

Pages refactored to pivot from stack version to platform, plus minor changes

Page Changes
✏️ Contribute on the web Refactored away from stack version to platform, added cumulative documentation hints, added tagged deployment model warning
✏️ Contribute locally Add cumulative documentation hints, added tagged deployment model warning

Cleanup, minor changes, warnings

Page Changes
✏️ Syntax ref: Applies to Refactored examples into snippets to share between the cumulative documentation doc and this one, added info about how applies_to tags behave in the output (dynamic version #s)
✏️ Add a new repository to the docs Added a note about deployment models
✏️ Documenting versions and deployment types Added a warning that this is out of date
✏️ Version content patterns Added a warning that this is out of date

TODO (future PRs)

  • Central version config info in the cumulative docs / deployment models / applies syntax docs (done)
  • Fix or remove the /versions/ pages
  • General internal docs restructure + cleanup (we could probably remove some migration stuff)

@shainaraskas shainaraskas added the documentation Improvements or additions to documentation label Jun 26, 2025
@shainaraskas shainaraskas changed the title draft Deployment model selection, cumulative authoring, ++ Jun 26, 2025
@shainaraskas shainaraskas marked this pull request as ready for review June 26, 2025 20:53
@shainaraskas shainaraskas requested a review from a team as a code owner June 26, 2025 20:53
Comment on lines 93 to 99
## Configure a space-level landing page [space-landing-page]
```{applies_to}
stack: ga
serverless: unavailable
```
````
% I think we wanted to not specify stack here
Copy link
Contributor Author

@shainaraskas shainaraskas Jun 26, 2025

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)

Copy link
Contributor

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

Copy link
Contributor Author

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

Copy link
Contributor

@colleenmcginnis colleenmcginnis left a 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.

@shainaraskas shainaraskas changed the title Deployment model selection, cumulative authoring, ++ Branching strategy selection, cumulative authoring, ++ Jun 30, 2025
Copy link
Contributor

@colleenmcginnis colleenmcginnis left a 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.

Copy link
Contributor

@florent-leborgne florent-leborgne left a comment

Choose a reason for hiding this comment

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

Niceeee

@shainaraskas shainaraskas merged commit 907dea5 into main Jul 2, 2025
15 checks passed
@shainaraskas shainaraskas deleted the more-guidance-versioning branch July 2, 2025 16:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants