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

Add documentation about config #7765

Closed
4 tasks
robert-zaremba opened this issue Oct 30, 2020 · 5 comments · Fixed by #15544
Closed
4 tasks

Add documentation about config #7765

robert-zaremba opened this issue Oct 30, 2020 · 5 comments · Fixed by #15544
Assignees
Labels
T:Docs Changes and features related to documentation.

Comments

@robert-zaremba
Copy link
Collaborator

Summary

It seams we don't have any documentation about config files and major options.

For Admin Use

  • Not duplicate issue
  • Appropriate labels applied
  • Appropriate contributors tagged
  • Contributor assigned/self-assigned
@robert-zaremba robert-zaremba added the T:Docs Changes and features related to documentation. label Oct 30, 2020
@robert-zaremba
Copy link
Collaborator Author

robert-zaremba commented Oct 30, 2020

@clevinson , should we set it for 1.0 release? Or 0.40.x ?

@alexanderbez
Copy link
Contributor

The template describes all the options. I think we just need to copy and lift into a markdown file maybe. Maybe incorporate it into running a node doc @amaurymartiny worked on.

@robert-zaremba
Copy link
Collaborator Author

If the template describe all options, then we don't need to copy them. We just need to make a nice section about config: describe what are the most important options and files. And then we will just say, for details please look at that files.

@robert-zaremba
Copy link
Collaborator Author

In that case this could be part of 0.40.x

@alexanderbez
Copy link
Contributor

alexanderbez commented Nov 1, 2020

I think we should document all configs from that template in addition to what you've described.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T:Docs Changes and features related to documentation.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants