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

[R4R] New docs V1 (merge master-docs to master) #5379

Merged
merged 223 commits into from
Dec 10, 2019
Merged

Conversation

gamarin2
Copy link
Contributor

@gamarin2 gamarin2 commented Dec 9, 2019

Description

This PR brings to master all the docs changes that have been worked on in the past months. They are accompanied with a new docs website, the release of which is planned to coincide with the upcoming Hub upgrade.

Note that almost all changes included in this PR have already been reviewed in other PRs to the master-docs branch. Here is the list (there's prob more):

Note:
The new docs build process included in this PR should not break the current docs website. Instead, the new docs should be deployed to docs.cosmos.network. Therefore, it'd be great to merge this PR before end of tomorrow (Tuesday) so that we can test if it works properly. We will do a redirect from cosmos.network/docs to docs.cosmos.network after the Hub successfully upgrades.

Sidenote:
Companion Gaia PR: cosmos/gaia#183


For contributor use:

  • Targeted PR against correct branch (see CONTRIBUTING.md)
  • Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
  • Code follows the module structure standards.
  • Wrote unit and integration tests
  • Updated relevant documentation (docs/) or specification (x/<module>/spec/)
  • Added relevant godoc comments.
  • Added a relevant changelog entry to the Unreleased section in CHANGELOG.md
  • Re-reviewed Files changed in the Github PR explorer

For admin use:

  • Added appropriate labels to PR (ex. WIP, R4R, docs, etc)
  • Reviewers assigned
  • Squashed all commits, uses message "Merge pull request #XYZ: [title]" (coding standards)

gamarin2 and others added 30 commits May 20, 2019 14:08
Co-Authored-By: Alessio Treglia <quadrispro@ubuntu.com>
Co-Authored-By: Alexander Bezobchuk <alexanderbez@users.noreply.github.com>
Co-Authored-By: Federico Kunze <31522760+fedekunze@users.noreply.github.com>
Co-Authored-By: Alessio Treglia <quadrispro@ubuntu.com>
Co-Authored-By: frog power 4000 <rigel.rozanski@gmail.com>
Co-Authored-By: Karoly Albert Szabo <szabo.karoly.a@gmail.com>
Co-Authored-By: Federico Kunze <31522760+fedekunze@users.noreply.github.com>
@alexanderbez alexanderbez added T:Docs Changes and features related to documentation. R4R labels Dec 9, 2019
@@ -1,3 +1,8 @@
---
Copy link
Contributor

Choose a reason for hiding this comment

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

What is this for? (Note, this renders in markdown).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

we use that in the website build. I'll see with @fadeev if we can change convention to

<!-- 
--- 
parent:
  order: false
--- 
-->

so that it does not render in markdown

Copy link
Contributor

@fadeev fadeev Dec 10, 2019

Choose a reason for hiding this comment

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

<!-- won’t work out of the box, because VuePress parses files for --- (this is hard-coded into VP) and then passes them to gray-matter JS-lib for further conversion into JSON.

https://github.com/vuejs/vuepress/blob/master/packages/@vuepress/shared-utils/src/parseVueFrontmatter.ts#L5

Of course, we can comment frontmatter out and strip <!-- and --> at build even with something like sed 's/<!--//g' . That being said, I think we should think about maintainability of all this before we add any more custom things to our markdown files. I’m not saying we shouldn’t (I actually like extending stuff), I just think we should think about it, or we’ll to end up with a hodgepodge of custom syntax parsed with hacky shell-scripts.

Copy link
Collaborator

Choose a reason for hiding this comment

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

We should add a link on the docs/README.md to the rendered documentation on the website. I think that suffices (at least for me).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Great @fedekunze. Will do so as soon as this PR is merged.

We will think of ways to improve readability of github in later upgrades

@@ -30,5 +36,9 @@ Please add a entry below in your Pull Request for an ADR.
- [ADR 009: Evidence Module](./adr-009-evidence-module.md)
- [ADR 010: Modular AnteHandler](./adr-010-modular-antehandler.md)
- [ADR 011: Generalize Genesis Accounts](./adr-011-generalize-genesis-accounts.md)
<<<<<<< HEAD:docs/architecture/README.md
Copy link
Contributor

Choose a reason for hiding this comment

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

fix merge conflict remnants

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

@@ -1,3 +1,9 @@
---
Copy link
Contributor

Choose a reason for hiding this comment

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

ditto. can we avoid this being rendered in markdown?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Please see comments above

@fedekunze
Copy link
Collaborator

@gamarin2 or @fadeev can we add an entry on the CHANGELOG.md to this docs PR?

@gamarin2
Copy link
Contributor Author

Done @fedekunze

Copy link
Contributor

@alexanderbez alexanderbez left a comment

Choose a reason for hiding this comment

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

ACK -- delegating trust to the docs team et al that the contents are correct. Any corrections can be made in subsequent PRs.

@alexanderbez alexanderbez merged commit b18bd06 into master Dec 10, 2019
@alexanderbez alexanderbez deleted the master-docs branch December 10, 2019 14:29
@gamarin2 gamarin2 restored the master-docs branch December 11, 2019 11:40
xiangjianmeng pushed a commit to xiangjianmeng/cosmos-sdk that referenced this pull request Dec 18, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T:Docs Changes and features related to documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants