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

Consolidate "Basic Concepts" into 1-2 page overview #1433

Closed
2 tasks
Tracked by #1432
ElPaisano opened this issue Jan 23, 2023 · 1 comment · Fixed by #1457
Closed
2 tasks
Tracked by #1432

Consolidate "Basic Concepts" into 1-2 page overview #1433

ElPaisano opened this issue Jan 23, 2023 · 1 comment · Fixed by #1457
Assignees
@ElPaisano
Labels
dif/hard Having worked on the specific codebase is important effort/days Estimated to take multiple days, but less than a week need/analysis Needs further analysis before proceeding need/maintainers-input Needs input from the current maintainer(s) P2 Medium: Good to have, but can wait until someone steps up

Comments

@ElPaisano
Copy link
Contributor

ElPaisano commented Jan 23, 2023 •
edited
Loading

Currently, we have 8 pages under Concepts > Basic Concepts. These pages existed before the recent content reorganization, and were just reshuffled. There has been discussion about how we might combine some of these pages into a similar, more concise Basic Concepts section. The purpose of this issue is to discuss and settle on a refactor.

Assignee: @ElPaisano

Epic: #1432

Proposed Task:

  • Read pages currently under Basic Concepts and note the following:
    - Duplicate content
    - Outdated content
    - Incorrect content
    - Missing content
    - Confusing / misleading content
    - Broken links / links that should probably go somewhere else
    - Anything else that can be improved
  • Create PR to rewrite basic concepts into 1-2 pages
@ElPaisano ElPaisano added the need/triage Needs initial labeling and prioritization label Jan 23, 2023
@ElPaisano ElPaisano mentioned this issue Jan 23, 2023
Closed
3 tasks
@ElPaisano ElPaisano self-assigned this Jan 23, 2023
This was referenced Jan 23, 2023
Closed
Closed
@TMoMoreau TMoMoreau added dif/hard Having worked on the specific codebase is important P2 Medium: Good to have, but can wait until someone steps up need/analysis Needs further analysis before proceeding need/maintainers-input Needs input from the current maintainer(s) effort/days Estimated to take multiple days, but less than a week and removed need/triage Needs initial labeling and prioritization labels Jan 25, 2023
@TMoMoreau
Copy link
Contributor

I believe I had mentioned this already, but while it would be nice to have a one, maybe two, page consolidated version of these concepts, I would also like to see the full, uncondensed versions maintained in some way, for when users want to take a deeper dive into the topics.

(Also, I tagged this as "hard" because this is likely to require significant effort and understanding of the concepts, in order to create a sensible single page rundown of all of the important things.)

@ElPaisano ElPaisano added this to the 1/20/27 - 2/3/22 milestone Jan 26, 2023
@ElPaisano ElPaisano mentioned this issue Jan 26, 2023
Merged
5 tasks
@ElPaisano ElPaisano linked a pull request Jan 26, 2023 that will close this issue
Concepts overhaul: consolidate basic concepts into 2 page overview, ideas and theory #1457
Merged
5 tasks
@ElPaisano ElPaisano removed this from the 1/27/23 - 2/3/23 milestone Jan 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ElPaisano ElPaisano

Labels
dif/hard Having worked on the specific codebase is important effort/days Estimated to take multiple days, but less than a week need/analysis Needs further analysis before proceeding need/maintainers-input Needs input from the current maintainer(s) P2 Medium: Good to have, but can wait until someone steps up
Projects
None yet
Milestone
No milestone
2 participants
@TMoMoreau @ElPaisano