Skip to content
Jodie Putrino edited this page Apr 12, 2017 · 14 revisions

Welcome to the f5-ci-docs wiki!

Overview

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/.

Development

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.

Branching

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.

git cherry-pick -m 1 <commit>
git push upstream v1 

Review

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 bugfixes into the same PR, as long as each fix is only one commit. Be sure to reference the bug # in the commit message.

Releases

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.

Style, Voice, Tools, etc.

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.

Clone this wiki locally