-
Notifications
You must be signed in to change notification settings - Fork 27
Home
This repository is the home for solution documentation relating to the F5® Container Integrations. Content on the v1 branch corresponds to content in http://clouddocs.f5.com/containers/v1/.
All development should take place in a feature branch in your fork of this repo. Rebase from upstream/master often to ensure your fork is up to date. When you're ready to submit a pull request, rebase -i and squash your commits together if you have more than a handful.
All work should have a corresponding issue. Assign the "new product feature" label to issues relating to doc enhancements or additions for unreleased or newly-released features.
Master is the version of record (aka, the 'stable' version). All content on this branch has been reviewed and is ready for publication.
All bugfixes and solution doc enhancements (i.e., changes that do not introduce content for as-yet-unreleased features) should be cherry-picked to the release branch (v1) after they are merged into master. Open a pull request from the release branch in your fork to the upstream release branch. These can be self-merged once tests pass.
git cherry-pick -x -m 1 <commit>
git push origin/v1
Open pull requests for content that cannot be published yet against the pre-release branch for the product. These branches will be updated from master, then merged into master & cherry-picked to the release branch when the product is released.
All work should be done in your fork. When you're ready to add your work to this repo, open a pull request into master. Assign at least one member of the @ContainerConnector team to review the PR by @ mentioning them in your PR comment and/or assigning the PR to that person.
You can combine multiple small bugfixes into the same PR. Submit one commit per issue; reference the issue # in the commit message for each fix.
When new product versions release:
- update the releases and versioning doc
- merge the master branch into the release branch (v1) to publish the new content
- create a new release from the release branch (v1) and indicate the products/versions the release pertains to in the release notes.
NOTE: updated link to the style guide coming soon
Consult the F5 Open Source Documentation Style Guide if you have any questions about voice, style, tools, etc.