docs: update master docs #8353

lovincyrus · 2021-01-16T00:11:00Z

Description

/master

bump docs theme
add v0.40 to config.js versions

closes: #XXXX

to fix error Error rendering /core/cli.html: false when npm run build

Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

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
Review Codecov Report in the comment section below once CI passes

okwme · 2021-01-17T17:46:28Z

Will this make v0.40.0 the default version as well @lovincyrus ?

docs/.vuepress/config.js

okwme · 2021-01-19T08:03:40Z

Hmm, i’d maybe include progressively and leave warnings on the pages they’re not up to date. With the announcement I think a lot more people are looking ti the docs and expecting it to be the place to learn what’s going on.

On Mon, Jan 18, 2021 at 11:24 AM Amaury ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In docs/.vuepress/config.js <#8353 (comment)>: > + { + "label": "v0.40", + "key": "v0.40" + }, just a note: I'd say 0.40 docs are 90% done, however, a lot of them are not on the release/v0.40.x branch yet, and need to be backported (will happen most likely in this week and next week). If you think it'd be better to wait until all docs are updated on release/v0.40.x first, we can also wait a bit for this PR. — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#8353 (review)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAHLLVEWX6XYFZDE4E4QPBDS2QD7PANCNFSM4WEZDTLQ> .

-- billyrennekamp.com

clevinson · 2021-01-20T23:28:56Z

This PR only adds the dropdown handle for v0.40, but the actual http://docs.cosmos.network/v0.40/ site is broken, and docs have not been able to build on circleci for the past few weeks. Can we make sure that the v0.40 docs are successfully deployed before merging this? Otherwise, the dropdown will lead to a dead page.

alessio · 2021-01-21T00:29:39Z

Bump @lovincyrus (CC'ing @fadeev for visibility)

lovincyrus · 2021-01-21T02:06:14Z

Just ran the latest of release/v0.40.x branch locally and deployed the build folder on Netlify and Vercel. Everything looks fine.

Netlify: https://release-v0-40-x-docs.vercel.app/intro/overview.html
Vercel: https://release-v0-40-x-docs.lovincyrus.vercel.app/intro/overview.html

and docs have not been able to build on circleci for the past few weeks. @clevinson

RE: Circleci

Marko has removed circleci and deployed docs on github-pages docs: deploy to github pages #8321

gh-pages
  - /master
  - /v0.39
  - /v0.40

Just deployed gh-pages on Vercel: https://cosmos-sdk-gh-pages.vercel.app — It works.

Not sure what went wrong to the v0.40 dir. ~~Can we somehow redeploy the gh-pages branch? @marbar3778~~

Tested npm run serve locally, npm run build builds without error, checked console log, deployed release/v0.40.x a.k.a /v0.40 on Netlify and Vercel.
I've also deployed the latest gh-pages here: https://cosmos-sdk-gh-pages.vercel.app
If you look at https://cosmos-sdk-gh-pages.vercel.app/v0.40/intro/overview.html, it's on /v0.40. PS: the version switcher is "broken", because it doesn't have v0.40 listed in the config.js

DNS: https://mxtoolbox.com/SuperTool.aspx?action=http%3a%2f%2fdocs.cosmos.network%2f&run=toolpage

~~For some reason, it's still showing AmazonS3. Didn't we update the DNS of docs and point it to https://cosmos.github.io/cosmos-sdk? cc: @helder-moreira @marbar3778~~

Update: https://docs.cosmos.network/v0.40's DNS has been updated and it's now using Github pages.

lovincyrus · 2021-01-21T02:14:25Z

I will go ahead and convert this PR to a draft until http://docs.cosmos.network/v0.40/ is not dead. #8353 (comment)

lovincyrus · 2021-01-22T19:35:00Z

There's a deadlink that causes build error:

https://github.com/cosmos/cosmos-sdk/blob/master/docs/core/cli.md#L99

Here is an example of a `queryCmd` aggregating subcommands from the `simapp` application:

+++ https://github.com/cosmos/cosmos-sdk/blob/0.40.0/simapp/simd/cmd/root.go#L99-L121

Could we update that @amaurymartiny 💯

Once that's resolved, this PR is ready to merge.

amaury1093 · 2021-01-25T10:16:18Z

Could we update that @amaurymartiny 💯

Sure, can I just push this fix to this branch? (or would you like to do it?)

lovincyrus · 2021-01-25T20:04:28Z

Sure, can I just push this fix to this branch? (or would you like to do it?)

Either way works. Feel free to just push to this branch.

amaury1093 · 2021-01-29T10:59:16Z

docs/.vuepress/config.js

@@ -38,6 +38,10 @@ module.exports = {
      index: "cosmos-sdk"
    },
    versions: [
+      {
+        "label": "v0.40",
+        "key": "v0.40"


Now that the v0.40 has been kind of yanked, should we just show v0.39, v0.41 and master?

if we don't plan on using v0.40, then we shouldn't include it in the version dropdown. Can you confirm that? @amaurymartiny

Question about this. A recent bugfix (#8461) makes 0.40.* and 0.41.* buggy for ALL chains except gaia. Maybe in the docs we should just skip 0.40 and 0.41 altogether? And show 0.42 directly?

cc @clevinson

Or actually, for 0.41, it would be ideal to show a banner on top of the page saying "if you're not using the hub, please upgrade to 0.42". wdyt?

Yes i like this approach. Let's only show docs for v0.41 and v0.42, and have v0.41 clearly point out that there is an evidence bug on v0.41.x that renders chains unstable on v0.41.x if they have a non-default bech32 prefix.

@lovincyrus can we update this accordingly & merge? This should also include then an update to the versions file, as we now have a release/v0.41.x branch, and most stargate docs updates will only be be backported to there.

only show docs for v0.41 and v0.42

~~Are we only showing v0.41 and v0.42 and get rid of v0.39 and master from the version dropdown?~~

nvm, just saw this #8353 (review)

okwme · 2021-01-29T15:56:37Z

ja!, also would be good to fix so that it is automatically selected. There's some problems when it shows "master" in the URL it doesn't work and is shown as blank. Also would be good to actually move to the top left, i think it's very hard to see it in the current location and typically docs list this above the left side menu, right?

…

On Fri, Jan 29, 2021 at 11:59 AM Amaury ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In docs/.vuepress/config.js <#8353 (comment)>: > @@ -38,6 +38,10 @@ module.exports = { index: "cosmos-sdk" }, versions: [ + { + "label": "v0.40", + "key": "v0.40" Now that the v0.40 has been kind of yanked, should we just show v0.39, v0.41 and master? — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#8353 (review)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAHLLVELLN52THSYUKAO52DS4KIJXANCNFSM4WEZDTLQ> .

-- billyrennekamp.com

lovincyrus · 2021-02-06T01:38:33Z

would be good to actually move to the top left, i think it's very hard to see it in the current location and typically docs list this above the left side menu, right?

Docs typically list this on the top right nav bar.

References:

lovincyrus · 2021-02-06T02:24:26Z

There's some problems when it shows "master" in the URL it doesn't work and is shown as blank.

If you're referring to http://localhost:8080/master when you run it locally on this branch, that's expected because we don't have /master in the docs dir. The docs are deployed from this branch.

okwme · 2021-02-06T16:22:04Z

I'd submit vuejs.org as a counter example for putting the version in the top left but what i think really makes me look to the top left is seeing so many gitbooks which also default to that spot (example). This is not a hill I'll die on, but those are my two cents.

What I am more concerned with is making sure its visible and correct.

When the URL doesn't match the path it shows up as empty. I think we have some options with customized routing rules (not sure if we're using netlify or github at this point) but I don't know how the routing rules interact with this dropdown. Just know that I've come to the site through various paths and realized it wasn't correct. I'm sure you've considered this before Cyrus and I'd be keen to hear your opinion on what should happen that could be useful as a guiding light in the hunt to find all edge cases where it's not happening. (bonus points if we come up with a system that is flexible on jumps to semver since we're basically foresaking v0.40.x in favor of v0.41.x)

amaury1093

Any updates on this? imo the ideal solution would be:

dropdown showing 0.39, 0.41, master, defaulting to 0.41 (no strong opinion on top-left or top-right)
not mention 0.40 in the docs

tac0turtle · 2021-02-22T15:40:45Z

This is blocking getting modules onto atlas.

lovincyrus · 2021-02-22T21:48:57Z

I'll focus on cleaning up the version dropdown in this PR. Regarding the position of version dropdown, I've created an issue cosmos/vuepress-theme-cosmos#189. Let's move our discussion there and submit another PR next time.

* 0.39, 0.41, master * defaulting to 0.41

9989bea

clevinson

👍 @lovincyrus thanks!

Let's make sure this gets backported to launchpad/backports and release/v0.41.x as well.

I think mergify should be able to take care of this now?

amaury1093 · 2021-02-23T10:55:49Z

thanks @lovincyrus !

* bump docs theme to 1.0.180 * add v0.40 to config.js versions * Fix code snippet link * reorganize order of versions * 0.39, 0.41, master * defaulting to 0.41 Co-authored-by: billy rennekamp <billy.rennekamp@gmail.com> Co-authored-by: Amaury Martiny <amaury.martiny@protonmail.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> (cherry picked from commit 4c70268) # Conflicts: # docs/package-lock.json

* docs: update master docs (#8353) * bump docs theme to 1.0.180 * add v0.40 to config.js versions * Fix code snippet link * reorganize order of versions * 0.39, 0.41, master * defaulting to 0.41 Co-authored-by: billy rennekamp <billy.rennekamp@gmail.com> Co-authored-by: Amaury Martiny <amaury.martiny@protonmail.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> (cherry picked from commit 4c70268) # Conflicts: # docs/package-lock.json * rm package-lock.json, reinstall Co-authored-by: Cyrus Goh <hello@lovincyrus.com>

lovincyrus added 2 commits January 15, 2021 15:56

bump docs theme to 1.0.180

d927d73

add v0.40 to config.js versions

a189ff6

lovincyrus requested review from aaronc, alessio and alexanderbez as code owners January 16, 2021 00:11

lovincyrus requested a review from tac0turtle January 16, 2021 00:11

Merge branch 'master' into cyrus/master-docs

3411b80

amaury1093 approved these changes Jan 18, 2021

View reviewed changes

amaury1093 reviewed Jan 18, 2021

View reviewed changes

docs/.vuepress/config.js Outdated Show resolved Hide resolved

lovincyrus marked this pull request as draft January 21, 2021 02:14

lovincyrus added 2 commits January 21, 2021 11:15

resolve conflicts

26bb55a

Merge branch 'master' into cyrus/master-docs

dc51027

lovincyrus mentioned this pull request Jan 22, 2021

Check deadlinks cosmos/vuepress-theme-cosmos#184

Open

Fix code snippet link

f91c549

amaury1093 approved these changes Jan 26, 2021

View reviewed changes

lovincyrus marked this pull request as ready for review January 26, 2021 17:13

Merge branch 'master' into cyrus/master-docs

8537107

amaury1093 added T:Docs Changes and features related to documentation. A:automerge Automatically merge PR once all prerequisites pass. labels Jan 28, 2021

amaury1093 reviewed Jan 29, 2021

View reviewed changes

amaury1093 requested a review from clevinson January 29, 2021 10:59

Merge branch 'master' into cyrus/master-docs

e98f849

amaury1093 mentioned this pull request Feb 22, 2021

docs: update v0.40 docs #8423

Closed

9 tasks

amaury1093 previously requested changes Feb 22, 2021

View reviewed changes

tac0turtle mentioned this pull request Feb 22, 2021

atlas: add modules to atlas #8589

Closed

9 tasks

lovincyrus mentioned this pull request Feb 22, 2021

Position of version dropdown cosmos/vuepress-theme-cosmos#189

Open

lovincyrus added 2 commits February 22, 2021 13:49

Merge branch 'master' into cyrus/master-docs

b0423d6

reorganize order of versions

9989bea

* 0.39, 0.41, master * defaulting to 0.41

lovincyrus requested a review from amaury1093 February 22, 2021 22:06

clevinson added backport/0.39.x (Launchpad) labels Feb 23, 2021

clevinson approved these changes Feb 23, 2021

View reviewed changes

amaury1093 approved these changes Feb 23, 2021

View reviewed changes

Merge branch 'master' into cyrus/master-docs

df9f27e

mergify bot merged commit 4c70268 into master Feb 23, 2021

mergify bot deleted the cyrus/master-docs branch February 23, 2021 10:57

mergify bot mentioned this pull request Feb 23, 2021

docs: update master docs (bp #8353) #8672

Merged

amaury1093 mentioned this pull request Feb 24, 2021

Deploy 0.40 docs on "/" #8019

Closed

6 tasks

lovincyrus mentioned this pull request Feb 24, 2021

docs: tweak versions to 0.39, 0.41, master of launchpad/backports #8688

Merged

10 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: update master docs #8353

docs: update master docs #8353

lovincyrus commented Jan 16, 2021 •

edited

Loading

okwme commented Jan 17, 2021

okwme commented Jan 19, 2021 via email

clevinson commented Jan 20, 2021

alessio commented Jan 21, 2021

lovincyrus commented Jan 21, 2021 •

edited

Loading

lovincyrus commented Jan 21, 2021

lovincyrus commented Jan 22, 2021

amaury1093 commented Jan 25, 2021

lovincyrus commented Jan 25, 2021

amaury1093 Jan 29, 2021

lovincyrus Feb 6, 2021

okwme Feb 6, 2021

amaury1093 Feb 8, 2021

amaury1093 Feb 10, 2021

clevinson Feb 10, 2021

clevinson Feb 10, 2021

lovincyrus Feb 22, 2021 •

edited

Loading

okwme commented Jan 29, 2021 via email

lovincyrus commented Feb 6, 2021 •

edited

Loading

lovincyrus commented Feb 6, 2021

okwme commented Feb 6, 2021

amaury1093 left a comment

tac0turtle commented Feb 22, 2021

lovincyrus commented Feb 22, 2021

clevinson left a comment

amaury1093 commented Feb 23, 2021

docs: update master docs #8353

docs: update master docs #8353

Conversation

lovincyrus commented Jan 16, 2021 • edited Loading

Description

okwme commented Jan 17, 2021

okwme commented Jan 19, 2021 via email

clevinson commented Jan 20, 2021

alessio commented Jan 21, 2021

lovincyrus commented Jan 21, 2021 • edited Loading

lovincyrus commented Jan 21, 2021

lovincyrus commented Jan 22, 2021

amaury1093 commented Jan 25, 2021

lovincyrus commented Jan 25, 2021

amaury1093 Jan 29, 2021

Choose a reason for hiding this comment

lovincyrus Feb 6, 2021

Choose a reason for hiding this comment

okwme Feb 6, 2021

Choose a reason for hiding this comment

amaury1093 Feb 8, 2021

Choose a reason for hiding this comment

amaury1093 Feb 10, 2021

Choose a reason for hiding this comment

clevinson Feb 10, 2021

Choose a reason for hiding this comment

clevinson Feb 10, 2021

Choose a reason for hiding this comment

lovincyrus Feb 22, 2021 • edited Loading

Choose a reason for hiding this comment

okwme commented Jan 29, 2021 via email

lovincyrus commented Feb 6, 2021 • edited Loading

lovincyrus commented Feb 6, 2021

okwme commented Feb 6, 2021

amaury1093 left a comment

Choose a reason for hiding this comment

tac0turtle commented Feb 22, 2021

lovincyrus commented Feb 22, 2021

clevinson left a comment

Choose a reason for hiding this comment

amaury1093 commented Feb 23, 2021

lovincyrus commented Jan 16, 2021 •

edited

Loading

lovincyrus commented Jan 21, 2021 •

edited

Loading

lovincyrus Feb 22, 2021 •

edited

Loading

lovincyrus commented Feb 6, 2021 •

edited

Loading