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.

Sign up for GitHub

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

Jump to bottom

docs: Update v0.34.x to prepare for v0.37 #9244

Merged
merged 22 commits into from
Aug 19, 2022
Merged

docs: Update v0.34.x to prepare for v0.37 #9244

merged 22 commits into from
Aug 19, 2022

Conversation

thanethomson
Copy link
Contributor

Partially addresses #9096.

Similar to #9243, but targets the v0.34.x branch.

PR checklist

  • Tests written/updated, or no tests needed
  • CHANGELOG_PENDING.md updated, or no changelog entry needed
  • Updated relevant documentation (docs/) and code comments, or no
    documentation updates needed

@thanethomson thanethomson mentioned this pull request Aug 13, 2022
Merged
3 tasks
@thanethomson thanethomson marked this pull request as ready for review August 13, 2022 14:31
@thanethomson thanethomson requested a review from a team August 13, 2022 21:30
@thanethomson thanethomson changed the title docs: Update v0.34.x docs to prepare for v0.37 docs: Update v0.34.x to prepare for v0.37 Aug 13, 2022
@thanethomson thanethomson mentioned this pull request Aug 13, 2022
Merged
3 tasks
@tychoish
Copy link
Contributor

I think we just need to be ready to watch this deploy and revert quickly if it breaks

@thanethomson thanethomson marked this pull request as draft August 15, 2022 16:37
cason
cason approved these changes Aug 16, 2022
View reviewed changes
Copy link
Contributor

@cason cason left a comment

Choose a reason for hiding this comment

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

I was just wondering whether providing links of the format https://docs.tendermint.com/main/something is a good idea.

I think the links should be on the format ttps://docs.tendermint.com/something, so we have the freedom to redirect them to the full path of our preference.

docs/DOCS_README.md Outdated
@@ -2,39 +2,39 @@

The documentation for Tendermint Core is hosted at:

- <https://docs.tendermint.com/master/>
- <https://docs.tendermint.com/main/>
Copy link
Contributor

Choose a reason for hiding this comment

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

This is a broken link now. The link ending with master works.

But should we consider docs.tendermint.com without master or main at the end as the host of the main documentation?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The link will work once we merge #9243.

https://docs.tendermint.com/ automatically shows the latest stable docs (in our case, right now it shows the v0.34 docs).

docs/tendermint-core/using-tendermint.md Outdated
@@ -183,7 +183,7 @@ endpoints. Some take no arguments (like `/status`), while others specify
the argument name and use `_` as a placeholder.


> TIP: Find the RPC Documentation [here](https://docs.tendermint.com/master/rpc/)
> TIP: Find the RPC Documentation [here](https://docs.tendermint.com/main/rpc/)
Copy link
Contributor

Choose a reason for hiding this comment

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

It should be nice if https://docs.tendermint.com/rpc/ was the address of this documentation, even though under the hood if redirected to [master/main/latest]/rpc/

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's not clear whether our theme actually supports this right now.

rpc/openapi/openapi.yaml
@@ -51,10 +51,10 @@ info:

ws ws://localhost:26657/websocket
> { "jsonrpc": "2.0", "method": "subscribe", "params": ["tm.event='NewBlock'"], "id": 1 }
version: "Master"
version: "v0.34"
Copy link
Contributor

Choose a reason for hiding this comment

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

The v0.34 tag points to main?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

No, this was incorrectly labelled. Take a look at https://docs.tendermint.com/v0.34/rpc/: the "Master" tag to the top-right of the "Tendermint RPC" heading should actually read "v0.34", because it's the OpenAPI spec for v0.34.

This is mostly a cosmetic thing, but I think it's important we label things correctly.

@thanethomson thanethomson force-pushed the thane/9096-tmdocs-v0.34.x branch 2 times, most recently from 07794f6 to 2bfbb98 Compare August 18, 2022 01:12
@thanethomson thanethomson marked this pull request as ready for review August 18, 2022 01:17
@thanethomson thanethomson mentioned this pull request Aug 18, 2022
Closed
39 tasks
@thanethomson
Ignore generated/copied RPC docs
8a901c4 
Signed-off-by: Thane Thomson <connect@thanethomson.com>
@thanethomson
Sync vuepress config with main
0a5c5f0 
Signed-off-by: Thane Thomson <connect@thanethomson.com>
@thanethomson
Sync docs package-lock.json with main
b761a32 
Signed-off-by: Thane Thomson <connect@thanethomson.com>
@thanethomson
Sync docs redirects with main
953bba0 
Signed-off-by: Thane Thomson <connect@thanethomson.com>
@thanethomson
Sync docs versions with main
8ebdce8 
Signed-off-by: Thane Thomson <connect@thanethomson.com>
@thanethomson
Update OpenAPI version to v0.34
299c3f6 
Signed-off-by: Thane Thomson <connect@thanethomson.com>
@thanethomson
Sync DOCS_README with main
64cd5ba 
Signed-off-by: Thane Thomson <connect@thanethomson.com>
@thanethomson
Update all v0.34.x docs references from master to main
9b02ec9 
Signed-off-by: Thane Thomson <connect@thanethomson.com>
@thanethomson
Update v0.34 OpenAPI references from master to main
007758c 
Signed-off-by: Thane Thomson <connect@thanethomson.com>
@thanethomson
Update repo doc links from master to main
33918f4 
Signed-off-by: Thane Thomson <connect@thanethomson.com>
@thanethomson
Update code comment references from master to main
8063173 
Signed-off-by: Thane Thomson <connect@thanethomson.com>
@thanethomson
Update repo root doc links from master to main
b1b610d 
Signed-off-by: Thane Thomson <connect@thanethomson.com>
@thanethomson
Update repo root doc links for docs.tendermint.com from master to main
5609722 
Signed-off-by: Thane Thomson <connect@thanethomson.com>
@thanethomson
Build v0.34.x as "latest"
5f25ad9 
Signed-off-by: Thane Thomson <connect@thanethomson.com>
@thanethomson
Explicitly mark v0.34 docs as latest in version selector
5d779a1 
Signed-off-by: Thane Thomson <connect@thanethomson.com>
@thanethomson
Add nav link to main and clearly mark as unstable
5904f0f 
Signed-off-by: Thane Thomson <connect@thanethomson.com>
@thanethomson
Direct all docs.tendermint.com links to v0.34 on v0.34.x
0cc5538 
Signed-off-by: Thane Thomson <connect@thanethomson.com>
@thanethomson
Update all relevant links on v0.34.x branch to be v0.34-specific
16ab43c 
Signed-off-by: Thane Thomson <connect@thanethomson.com>
@thanethomson
Update changelog refs to docs.tendermint.com
806a91e 
Signed-off-by: Thane Thomson <connect@thanethomson.com>
@thanethomson
Update remaining GH master link to main
3adf86f 
Signed-off-by: Thane Thomson <connect@thanethomson.com>
@thanethomson
Sync docs build and nav config with main
84ad768 
Signed-off-by: Thane Thomson <connect@thanethomson.com>
@thanethomson
Migrate spec links to GitHub repo from docs site
82c109c 
Signed-off-by: Thane Thomson <connect@thanethomson.com>
@thanethomson thanethomson merged commit eed27ad into v0.34.x Aug 19, 2022
@thanethomson thanethomson deleted the thane/9096-tmdocs-v0.34.x branch August 19, 2022 11:20
@thanethomson thanethomson mentioned this pull request Dec 23, 2022
Closed
38 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tychoish tychoish tychoish approved these changes

@cason cason cason approved these changes

@ebuchman ebuchman Awaiting requested review from ebuchman

@cmwaters cmwaters Awaiting requested review from cmwaters

@williambanfield williambanfield Awaiting requested review from williambanfield

Assignees
No one assigned
Labels
None yet
Projects
Tendermint
Status: Done/Merged
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@thanethomson @tychoish @cason