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

Simplify contributing #395

Open
wants to merge 14 commits into
base: main
Choose a base branch
from
Open

Conversation

fyliu
Copy link
Member

@fyliu fyliu commented Oct 2, 2024

Fixes #267

What changes did you make?

  • Moved CONTRIBUTING.md sections into files and created links from the original file
    • The original file became the section index page.
  • Created contributing/ directory and moved contributing files inside
  • Moved tools/ and howto/ (Developer How-to Guides) into contributing/
  • Updated links for the above changes.

Why did you make the changes (we will use this info to test)?

  • To split the long contributing docs file into topic pages so it'll be easier to add and make changes going forward.
  • To organize contributing pages into the Contributing section. Leave main sections for user/customer documentation.

Screenshots of Proposed Changes Of The Website

Before link

Visuals before changes are applied
  • Boxes show where the pages were originally.
  • The page table of contents used to be on the right.
  • There were numbering in the titles, because the document was so long
    • Having numbers as part of the titles (rounded boxes) made it difficult to insert new content because of having to re-number everything after it.

2024-10-03 09 37 34 hackforla github io e4315503883e

After link

Visuals after changes are applied
  • Now, all contributor pages are organized under the "Contributing" section (boxed), leaving the main sections for "customers" (API client developers).
  • There's a Contributing index page with links pointing to the other pages.

2024-10-02 14 50 42 localhost 38543a596a76

  • Now, page table of contents are on the left, which frees up the right-hand space for the main content.

2024-10-03 09 49 44 localhost 2f2a7a604ea8

- compose file no longer uses versioning
- Dockerfile env vars use = signs
@fyliu fyliu self-assigned this Oct 3, 2024
@fyliu fyliu marked this pull request as ready for review October 3, 2024 17:26
@shmonks shmonks self-requested a review October 4, 2024 00:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: PR Needs review (automated column, do not place items here manually)
Development

Successfully merging this pull request may close these issues.

docs: simplify contributing page
1 participant