Skip to content

docs ADR#2828

Merged
ebuchman merged 4 commits intodevelopfrom
zach/adr-035
Nov 15, 2018
Merged

docs ADR#2828
ebuchman merged 4 commits intodevelopfrom
zach/adr-035

Conversation

@zramsay
Copy link
Contributor

@zramsay zramsay commented Nov 13, 2018

closes #2744

  • Updated all relevant documentation in docs
  • Updated all code comments where relevant
  • Wrote tests
  • Updated CHANGELOG_PENDING.md

@codecov-io
Copy link

Codecov Report

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

@@             Coverage Diff             @@
##           develop    #2828      +/-   ##
===========================================
+ Coverage    62.25%   62.31%   +0.06%     
===========================================
  Files          212      212              
  Lines        17253    17209      -44     
===========================================
- Hits         10740    10723      -17     
+ Misses        5610     5585      -25     
+ Partials       903      901       -2
Impacted Files Coverage Δ
privval/tcp_server.go 78.57% <0%> (-2.86%) ⬇️
consensus/reactor.go 66.51% <0%> (-1.16%) ⬇️
rpc/client/httpclient.go 68.78% <0%> (-0.98%) ⬇️
rpc/core/mempool.go 0% <0%> (ø) ⬆️
libs/pubsub/pubsub.go 83.89% <0%> (ø) ⬆️
rpc/core/consensus.go 0% <0%> (ø) ⬆️
mempool/reactor.go 64.19% <0%> (ø) ⬆️
consensus/state.go 79.78% <0%> (ø) ⬆️
tools/tm-bench/statistics.go 0% <0%> (ø) ⬆️
consensus/replay_file.go 0% <0%> (ø) ⬆️
... and 5 more

Copy link
Contributor

@melekes melekes left a comment

Choose a reason for hiding this comment

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

🍇

### Negative

A significant portion of the docs automation / build process is in private repos with limited access/visibility to devs. However, these tasks are handled by the SRE team.

Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* no full-text search
* no ability to view docs per release

Copy link
Contributor Author

Choose a reason for hiding this comment

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

there's a commit in the docs that show the latest version, is that what you mean?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Copy link
Contributor

Choose a reason for hiding this comment

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

screenshot 2018-11-15 at 20 05 00

Copy link
Contributor

Choose a reason for hiding this comment

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

I.e. I can switch to stable version

Copy link
Contributor Author

Choose a reason for hiding this comment

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

oh i see what you mean. yeah, that was a nice feature of RTD, a bit harder to implement with the current docs automation


### TODO

- Organize & improve the Tendermint documentation using: https://www.divio.com/blog/documentation/
Copy link
Contributor

Choose a reason for hiding this comment

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

not sure we need to put TODOs here. ADR is more about concrete decision and its consequences.

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, i agree

@zramsay
Copy link
Contributor Author

zramsay commented Nov 15, 2018

I've made the two negative you added issues in the devops repo, and the TODOs are all issues in the tendermint repo already

Copy link
Contributor

@ebuchman ebuchman left a comment

Choose a reason for hiding this comment

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

Thanks Zach!

@ebuchman ebuchman merged commit c033975 into develop Nov 15, 2018
@ebuchman ebuchman deleted the zach/adr-035 branch November 15, 2018 23:08
@ebuchman
Copy link
Contributor

Oh - there was no mention of https://www.divio.com/blog/documentation/

Do we want to include that? We should probably spend some time thinking about how our existing documentation could be improved to better match what's outlined there

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