Skip to content

Bucky/docs cleanup#2522

Merged
ebuchman merged 5 commits intodevelopfrom
bucky/docs-cleanup
Sep 30, 2018
Merged

Bucky/docs cleanup#2522
ebuchman merged 5 commits intodevelopfrom
bucky/docs-cleanup

Conversation

@ebuchman
Copy link
Contributor

@ebuchman ebuchman commented Sep 30, 2018

Closes #2376 and #2378.

Small makeover/improvements to docs:

  • Fix some mismatches between files/headers/links. Fix some links
  • Add and cleanup the READMEs
    • TODO: can we get the sidebar headers to be links to these?
  • DEPRECATE:
    • docs/introduction/introduction.md - moved to introduction/what-is-tendermint.md
    • docs/networks/deploy-testnets.md - it's mostly duplication of other information and doesn't read that well. Let's encourage people to look at tendermint testnet --help and understand the Tendermint Core section instead. Otherwise replaces with docs/networks/docker-compose.md.
    • networks/local/README.md - moved to docs/networks/docker-compose.md

@codecov-io
Copy link

Codecov Report

Merging #2522 into develop will increase coverage by 0.19%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           develop   #2522      +/-   ##
==========================================
+ Coverage    61.31%   61.5%   +0.19%     
==========================================
  Files          202     202              
  Lines        16710   16668      -42     
==========================================
+ Hits         10246   10252       +6     
+ Misses        5599    5553      -46     
+ Partials       865     863       -2
Impacted Files Coverage Δ
libs/clist/clist.go 66.49% <0%> (-1.53%) ⬇️
libs/db/remotedb/grpcdb/server.go 0% <0%> (ø) ⬆️
consensus/state.go 77.54% <0%> (+0.23%) ⬆️
p2p/pex/pex_reactor.go 74.33% <0%> (+0.33%) ⬆️
consensus/reactor.go 73.38% <0%> (+0.77%) ⬆️

@ebuchman
Copy link
Contributor Author

Tested with a local vuepress build. Please review, but merging so we can see it on staging.

@ebuchman ebuchman merged commit ead9fc0 into develop Sep 30, 2018
@ebuchman ebuchman deleted the bucky/docs-cleanup branch September 30, 2018 16:35
# Remote Cluster with Terraform and Ansible

See the [docs](/docs/terraform-and-ansible.md)
See the [docs](https://tendermint.com/docs/networks/terraform-and-ansible.html).
Copy link
Contributor

Choose a reason for hiding this comment

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

don't we want Github links to still work?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Like we should just link to the github markdown here instead of the website docs?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes

Copy link
Contributor

Choose a reason for hiding this comment

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

/cc @zramsay

Copy link
Contributor

Choose a reason for hiding this comment

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

see #links in the DOCS_README

Copy link
Contributor

Choose a reason for hiding this comment

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

should be relative links - they work everywhere and are permanent


DEPRECATED!

See the [docs](https://tendermint.com/docs/networks/docker-compose.html).
Copy link
Contributor

Choose a reason for hiding this comment

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

use relative links. see DOCS_REAMDE

@@ -0,0 +1,15 @@
# Introduction

Copy link
Contributor

Choose a reason for hiding this comment

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

what's the point of this file? it isn't added to the sidebar ... (config.js didn't change in this PR)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I like all the sections having landing pages. Is that wrong? :P

Copy link
Contributor

Choose a reason for hiding this comment

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

it didn't add a landing page (except on GH) if not added to the config.js

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sure did! https://tendermint-staging.interblock.io/docs/introduction/

But it only works with the trailing slash!

Copy link
Contributor

Choose a reason for hiding this comment

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

ah, and it's only accessible from the link, there's nothing to navigate to it within the sidebar.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Right, hence my TODO in the opening comment for this PR:

TODO: can we get the sidebar headers to be links to these?

Think that's possible?

Copy link
Contributor

Choose a reason for hiding this comment

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

missed it, yup. spec has it, i'll update that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants