Skip to content

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

Merged
thanethomson merged 22 commits intov0.34.xfrom
thane/9096-tmdocs-v0.34.x
Aug 19, 2022
Merged

docs: Update v0.34.x to prepare for v0.37#9244
thanethomson merged 22 commits intov0.34.xfrom
thane/9096-tmdocs-v0.34.x

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 marked this pull request as ready for review August 13, 2022 14:31
@thanethomson thanethomson force-pushed the thane/9096-tmdocs-v0.34.x branch from a9303be to d06ae0f Compare August 13, 2022 21:30
@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
@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
@thanethomson thanethomson force-pushed the thane/9096-tmdocs-v0.34.x branch from d06ae0f to 115c672 Compare August 15, 2022 20:16
Copy link

@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.

The documentation for Tendermint Core is hosted at:

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

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).



> 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

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.

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

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 force-pushed the thane/9096-tmdocs-v0.34.x branch from 2bfbb98 to 0f46adb Compare August 18, 2022 01:31
@thanethomson thanethomson mentioned this pull request Aug 18, 2022
39 tasks
Signed-off-by: Thane Thomson <connect@thanethomson.com>
Signed-off-by: Thane Thomson <connect@thanethomson.com>
Signed-off-by: Thane Thomson <connect@thanethomson.com>
Signed-off-by: Thane Thomson <connect@thanethomson.com>
Signed-off-by: Thane Thomson <connect@thanethomson.com>
Signed-off-by: Thane Thomson <connect@thanethomson.com>
Signed-off-by: Thane Thomson <connect@thanethomson.com>
Signed-off-by: Thane Thomson <connect@thanethomson.com>
Signed-off-by: Thane Thomson <connect@thanethomson.com>
Signed-off-by: Thane Thomson <connect@thanethomson.com>
Signed-off-by: Thane Thomson <connect@thanethomson.com>
Signed-off-by: Thane Thomson <connect@thanethomson.com>
Signed-off-by: Thane Thomson <connect@thanethomson.com>
Signed-off-by: Thane Thomson <connect@thanethomson.com>
Signed-off-by: Thane Thomson <connect@thanethomson.com>
Signed-off-by: Thane Thomson <connect@thanethomson.com>
Signed-off-by: Thane Thomson <connect@thanethomson.com>
Signed-off-by: Thane Thomson <connect@thanethomson.com>
Signed-off-by: Thane Thomson <connect@thanethomson.com>
Signed-off-by: Thane Thomson <connect@thanethomson.com>
Signed-off-by: Thane Thomson <connect@thanethomson.com>
Signed-off-by: Thane Thomson <connect@thanethomson.com>
@thanethomson thanethomson force-pushed the thane/9096-tmdocs-v0.34.x branch from 0f46adb to 82c109c Compare August 19, 2022 10:51
@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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done/Merged

Development

Successfully merging this pull request may close these issues.

3 participants