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

Problem: k8s docs not clear about who they're for #2439

Merged
merged 1 commit into from Aug 6, 2018

Conversation

ttmc
Copy link
Contributor

@ttmc ttmc commented Aug 6, 2018

Solution: Add a note atop k8s docs pages to clarify who they're for

Notes:

  • This PR mostly adds a "Note" box at the top of several k8s docs pages, to clarify who those docs are for (and not for).
  • It also does some minor edits of other text, so the reader doesn't get the impression that this is how we do deployment (in the future).
  • I wasn't able to link to the page titled How to Set Up a BigchainDB Network because that page is written in Markdown. I didn't want to link to a specific URL, because it should link to the How to Set Up a BigchainDB Network page in whatever version of the docs that the reader is currently reading.
  • I intend to rename the Production Deployment Template page to Kubernetes Deployment Template and do move it later in the contents, but I'll do that in a follow-up PR. I didn't want to do that in this PR because it wouldn't have been as clear what I changed in the text of the k8s docs.

Solution: Add a note atop k8s docs pages to clarify who they're for
@ttmc ttmc self-assigned this Aug 6, 2018
@ttmc ttmc requested a review from muawiakh August 6, 2018 11:56
@muawiakh
Copy link
Contributor

muawiakh commented Aug 6, 2018

Will merge once travis is 🥗

@codecov-io
Copy link

Codecov Report

Merging #2439 into master will not change coverage.
The diff coverage is n/a.

@@          Coverage Diff           @@
##           master   #2439   +/-   ##
======================================
  Coverage      88%     88%           
======================================
  Files          40      40           
  Lines        2310    2310           
======================================
  Hits         2033    2033           
  Misses        277     277

@ttmc
Copy link
Contributor Author

ttmc commented Aug 6, 2018

@muawiakh Travis is now 🥗

@muawiakh muawiakh merged commit 32b64cc into bigchaindb:master Aug 6, 2018
@ttmc ttmc deleted the add-note-atop-k8s-docs branch August 6, 2018 13:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants