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.

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

docs: Remove deprecated "Interfaces" section #8294

Merged
merged 14 commits into from
Jan 18, 2021
Merged

Conversation

amaury1093
Copy link
Contributor

@amaury1093 amaury1093 commented Jan 11, 2021

Description

ref: #7661

The "Interfaces" section had the following docs:

  • lite: removed
  • query-lifecycle: moved to "basics", along with tx-lifecycle, and reworked. rendered
  • cli: moved to "core concepts", alongs grpc, rest..., and reworked. rendered
  • intro to interfaces: removed
  • rest: removed

The simulation docs inside "Using the SDK" never showed up, I put them in Core Concepts, where they might belong more.


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

@@ -1,20 +0,0 @@
# Getting Started
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 removed all docs from this folder. They mentioned LCD, gaia-lite, which I believe is all removed.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

cc @marbar3778 @alexanderbez : Are we okay to remove all docs from this folder?

@@ -1,70 +0,0 @@
<!--
Copy link
Contributor Author

Choose a reason for hiding this comment

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

removed docs concerning legacy REST. We already have:

  • docs for grpc-gateway
  • migration from REST

@@ -1,35 +1,33 @@
<!--
Copy link
Contributor Author

Choose a reason for hiding this comment

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

moving CLI to core concepts

@@ -1,5 +1,5 @@
<!--
Copy link
Contributor Author

Choose a reason for hiding this comment

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

moving query-lifecycle to basics

@amaury1093 amaury1093 added the T:Docs Changes and features related to documentation. label Jan 11, 2021
@fedekunze fedekunze added the A:automerge Automatically merge PR once all prerequisites pass. label Jan 13, 2021
Copy link
Collaborator

@robert-zaremba robert-zaremba left a comment

Choose a reason for hiding this comment

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

Let's confirm if we can remove lite client spec

11. [Object-Capabilities](./ocap.md)
12. [RunTx recovery middleware](./runtx_middleware.md)
13. [Simulation](./simulation.md)
14. [Protobuf documentation](./proto-docs.md)
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think we should use markdown autonumeration. So use 1. in every line to avoid useless changes.

failure?
- Run invariants on every operation with `-SimulateEveryOperation`. _Note_: this
will slow down your simulation **a lot**.
- Try adding logs to operations that are not logged. You will have to define a
Copy link
Collaborator

Choose a reason for hiding this comment

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

Why changing * to -?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

my editor did this. I can change back if it bothers you.

Copy link
Collaborator

Choose a reason for hiding this comment

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

It's OK, but I think we should avoid this kind of changes (I mean improving a style is OK, but here we don't change it).

@mergify mergify bot merged commit afda621 into master Jan 18, 2021
@mergify mergify bot deleted the am-7661-interfaces branch January 18, 2021 00:11
amaury1093 added a commit that referenced this pull request Jan 18, 2021
* Remove useless files, add app.toml section

* Rework docs

* Delete interfaces

* add correct next section references

* Finish CLI

* Small tweaks query

* Add simulation docs to core

* Add gRPC and REST

* Finish queyr lifecycle

* Updat examples

* Remove prereq

* fix links in simulation

* Use same enumeration in md

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
amaury1093 added a commit that referenced this pull request Feb 16, 2021
* Remove useless files, add app.toml section

* Rework docs

* Delete interfaces

* add correct next section references

* Finish CLI

* Small tweaks query

* Add simulation docs to core

* Add gRPC and REST

* Finish queyr lifecycle

* Updat examples

* Remove prereq

* fix links in simulation

* Use same enumeration in md

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
@barriebyron
Copy link
Contributor

@AmauryM oops front page needs updating too #9441

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A:automerge Automatically merge PR once all prerequisites pass. T:Docs Changes and features related to documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants