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

docs: adding an index for upgrade pages. #8291

Merged
merged 1 commit into from
Jul 25, 2017

Conversation

zbwright
Copy link
Contributor

Contributing guidelines

Please read our contribution workflow before submitting a pull request.

@heyitsanthony
Copy link
Contributor

The describes... parts after the links seem redundant since the link already describes the target document.

@zbwright
Copy link
Contributor Author

Agreed. We wanted it to be more than a list, but I didn't come up with anything more substantial. Maybe, for this page, it just remains a list? @joshix


This section contains documents specific to upgrading etcd clusters and applications.

Moving from etcd API v2 to API v3
Copy link

Choose a reason for hiding this comment

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

I think this may be easier to read if you bolded each subheading.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Also agreed. We don't have any of these sorts of pages yet. Part of this exercise will be defining the format.

Copy link
Contributor

@joshix joshix Jul 20, 2017

Choose a reason for hiding this comment

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

headings suffice. Line 5 is a h2 (##), and so on

@codecov-io
Copy link

Codecov Report

❗ No coverage uploaded for pull request base (master@46ee06a). Click here to learn what that means.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##             master    #8291   +/-   ##
=========================================
  Coverage          ?   76.33%           
=========================================
  Files             ?      346           
  Lines             ?    27056           
  Branches          ?        0           
=========================================
  Hits              ?    20652           
  Misses            ?     4919           
  Partials          ?     1485

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 46ee06a...385ed64. Read the comment docs.

@heyitsanthony
Copy link
Contributor

This should probably be linked in docs.md or have a README.md symlink pointing to itself in the upgrades directory since right now it's unreachable from any other repo doc

@zbwright
Copy link
Contributor Author

The files linked from this page are all listed in docs.md, down at the bottom of the page under "Upgrading and compatibility". Should I add a link to this page as well?

@heyitsanthony
Copy link
Contributor

@zbwright probably include it as an 'Upgrading' link under 'Maintenance' so the doc isn't dangling and remove the old upgrading section so there's no duplication?

@heyitsanthony
Copy link
Contributor

@zbwright please squash and this should be good to merge. Thanks!

@heyitsanthony heyitsanthony merged commit 05603c4 into etcd-io:master Jul 25, 2017
@zbwright zbwright deleted the upgrade-index branch July 25, 2017 21:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants