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 review and re-organization #3431

Merged
merged 15 commits into from
Sep 29, 2020
Merged

Docs review and re-organization #3431

merged 15 commits into from
Sep 29, 2020

Conversation

hsanjuan
Copy link
Contributor

@hsanjuan hsanjuan commented Aug 31, 2020 •
edited
Loading

LOTUS DOCS HAVE BEEN MOVED AND INTEGRATED IN DOCS.FILECOIN.IO.

This PR removes them from here and sets a front-page with a short intro to lotus and links to Lotus documentation sections in the new docs.

Some Lotus WIP architecture docs and some unpublished docs are left around for the Lotus team to decide what to do with them.

All former URLs will be redirected.

@hsanjuan hsanjuan marked this pull request as draft August 31, 2020 17:57
@hsanjuan

This comment has been minimized.

Sign in to view
@hsanjuan

This comment has been minimized.

Sign in to view
@hsanjuan

This comment has been minimized.

Sign in to view
@hsanjuan

This comment has been minimized.

Sign in to view
This was referenced Aug 31, 2020
Closed
Closed
Merged
@hsanjuan

This comment has been minimized.

Sign in to view
@hsanjuan
Docs review and re-organization
fe52c47 
This:

* Re-organizes the docs into sections that align with what docs.filecoin.io becoming:
  * An installation section
  * A "getting started" section (lotus client focused)
  * A "storing" section (lotus client focused)
  * A "mining" section (miner focused)
  * A "build" section (developer focused)
  * An legacy "architecture" section is left in the last place.

A few high-value documentation pages have been reviewed and updated with the latest recommendations:

* Installation section and lotus setup
* Miner setup
* etc.
...

Other pages have been correctly merged into the new relevant sections. Some pages have not been touched. The filesystem layout of the documentation has been changed into folders corresponding to the sections (as requested by @cw). Some pages that were not linked at all and/or where hidden, have been moved to "unclassified".

This should make the porting of the Lotus documentation to docs.filecoin.io much easier, while ensuring it is more up to date than it was before.

For the moment, this breaks most links as link-aliasing is not supported in lotus-docs.
@hsanjuan
Fix #2334: Specify seal options to disable with co-located storage wo…
a153e1d 
…rker
@hsanjuan
Fix architecture entry
af38c90
@hsanjuan
Fix filename
bd0c6a4
@hsanjuan hsanjuan marked this pull request as ready for review September 17, 2020 18:52
@hsanjuan
Copy link
Contributor Author

image

@hsanjuan hsanjuan mentioned this pull request Sep 18, 2020
Merged
magik6k
magik6k reviewed Sep 21, 2020
View reviewed changes
.circleci/config.yml Outdated
Comment on lines 349 to 356
docs-check:
executor: golang
steps:
- install-deps
- prepare
- run: make docsgen
- run: git --no-pager diff
- run: git --no-pager diff --quiet
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 really useful, is there an equivalent of this on the new site?

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 will hopefully be soon. It's on my list to port it.

magik6k
magik6k reviewed Sep 24, 2020
View reviewed changes
Copy link
Contributor

@magik6k magik6k left a comment

Choose a reason for hiding this comment

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

Just two comments

documentation/en/dev-tools-jaeger-tracing.md Outdated Show resolved Hide resolved
documentation/en/api-scripting-support.md
MINER_API_INFO="JWT_TOKEN:/ip4/127.0.0.1/tcp/2345/http"
```

You can also use `lotus auth api-info --perm admin` to quickly create _API_INFO env vars
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't see references to this command in the new docs

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 here for miners https://docs.filecoin.io/mine/lotus/seal-workers/#create-an-authentication-token, in the context where it's useful.

This for the rest: https://docs.filecoin.io/build/lotus/api-token-generation/

I'll add it also here https://docs.filecoin.io/get-started/lotus/configuration-and-advanced-usage/#controlling-a-remote-daemon

Copy link
Contributor Author

Choose a reason for hiding this comment

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

ok, I remember now. That creates API info vars that are only correct if the user has provided the external IP for Lotus in the config (I guess). Otherwise it is going to show a localhost address. This is a possible place for pitfalls. If they have to manually write the multiaddress because they just got a token with create-token, users will have to pay a bit more attention.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Does it use RemoteListenAddress at all? It seems to pick up ~/.lotus/api. That is going to be ultimately set to 127.0.0.1. It just does not seem like a very useful command.

Copy link
Contributor

Choose a reason for hiding this comment

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

RemoteListenAddress is used for cross-worker sector transfers.

~/.lotus/api should be updated after changing the api listen address in the config

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes but only the port. The output of the command is never going to give the actual IP:port multiaddress for a remote node, only for a local one.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

filecoin-project/filecoin-docs#435

magik6k
magik6k approved these changes Sep 29, 2020
View reviewed changes
Copy link
Contributor

@magik6k magik6k left a comment

Choose a reason for hiding this comment

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

LGTM.

The only thing I'd add here is a readme in documentation/en explaining what is supposed to be here and what is in docs.filecoin.io

@hsanjuan
Copy link
Contributor Author

LGTM.

The only thing I'd add here is a readme in documentation/en explaining what is supposed to be here and what is in docs.filecoin.io

added.

whyrusleeping
whyrusleeping approved these changes Sep 29, 2020
View reviewed changes
Copy link
Member

@whyrusleeping whyrusleeping left a comment

Choose a reason for hiding this comment

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

It was a good run, time to commit to docs.filecoin.io now though.

@magik6k magik6k merged commit 6025bce into master Sep 29, 2020
@magik6k magik6k deleted the feat/docs-reorg branch September 29, 2020 20:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@magik6k magik6k magik6k approved these changes

@Kubuxu Kubuxu Kubuxu approved these changes

@whyrusleeping whyrusleeping whyrusleeping approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@hsanjuan @whyrusleeping @Kubuxu @magik6k