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

Move config docs out of main README to separate file #9965

Closed
jryans opened this issue Jun 5, 2019 · 2 comments · Fixed by #10195
Closed

Move config docs out of main README to separate file #9965

jryans opened this issue Jun 5, 2019 · 2 comments · Fixed by #10195
Assignees
@jryans
Labels
P1 T-Task Tasks for the team like planning

Comments

@jryans
Copy link
Collaborator

jryans commented Jun 5, 2019

The config details seem too noisy for the main README. We should move them out to a separate file and link to it instead.
@turt2live
Copy link
Member

ideally in commented JSON form, a la #8899 (comment)

@lampholder lampholder added T-Task Tasks for the team like planning P1 labels Jun 6, 2019
@jryans jryans self-assigned this Jun 27, 2019
@jryans jryans added this to In Progress in Web App Team Jun 27, 2019
@jryans
Copy link
Collaborator Author

jryans commented Jun 27, 2019

Let's start by just moving the existing docs. We can extend from there to do various bits of #8899.

jryans added a commit that referenced this issue Jun 27, 2019
@jryans
Extract configuration docs to separate file
474f2d5 
The main README is very busy with too much information in one file. This
attempts to clean up one portion by moving configuration docs to a separate
file.

Fixes #9965
@jryans jryans mentioned this issue Jun 27, 2019
Merged
jryans added a commit that referenced this issue Jun 27, 2019
@jryans
Extract configuration docs to separate file
73d801c 
The main README is very busy with too much information in one file. This
attempts to clean up one portion by moving configuration docs to a separate
file.

Fixes #9965
@jryans jryans moved this from In Progress to In Review in Web App Team Jun 28, 2019
Web App Team automation moved this from In Review to In Test Jun 28, 2019
@jryans jryans moved this from In Test to Done in Web App Team Jul 8, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jryans jryans

Labels
P1 T-Task Tasks for the team like planning
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Extract configuration docs to separate file element-hq/element-web
3 participants
@jryans @turt2live @lampholder