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

refactor docs for bundle distribution clarity #243

Merged

Conversation

danielspofford
Copy link
Contributor

@danielspofford danielspofford commented Jan 10, 2025

  • Generally shift language to consider bundle management/distribution to be the higher level topic than releases; releases are a means of performing bundle distribution alongside bundle overrides.
  • Add a bundle distribution reference.
  • Add a bundle overrides reference.
  • Update the bundles reference to support the wider commit's changes and add a section on custom metadata.
  • Update cohorts reference to begin introducing release channel language.
  • Add a release channels reference.
  • Update the releases reference to support the wider commit's changes.
  • Update the device API spec to clarify header documentation and link to the relevant reference page.
  • Rework the sidebar slightly for clarity and consistency.
  • Move firmware and deployments references and guides into deprecated sections.

@danielspofford danielspofford force-pushed the spoff/eng-3895-update-docs-for-bundle-overrides branch from edad0df to 61a2715 Compare January 10, 2025 08:51
- Generally shift language to consider bundle management/distribution to
  be the higher level topic than releases; releases are a means of
  performing bundle distribution alongside bundle overrides.
- Add a bundle distribution reference.
- Add a bundle overrides reference.
- Update the bundles reference to support the wider commit's changes and
  add a section on custom metadata.
- Update cohorts reference to begin introducing release channel
  language.
- Add a release channels reference.
- Update the releases reference to support the wider commit's changes.
- Update the device API spec to clarify header documentation and link to
  the relevant reference page.
- Rework the sidebar slightly for clarity and consistency.
- Move firmware and deployments references and guides into deprecated
  sections.
@danielspofford danielspofford force-pushed the spoff/eng-3895-update-docs-for-bundle-overrides branch from 61a2715 to ea47dbb Compare January 10, 2025 08:56
@danielspofford danielspofford merged commit 2ff22ba into main Jan 10, 2025
3 checks passed
@danielspofford danielspofford deleted the spoff/eng-3895-update-docs-for-bundle-overrides branch January 10, 2025 09:09
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.

1 participant