Skip to content

Add contributing guidelines and organize developer documentation#4345

Merged
MisRob merged 5 commits intolearningequality:unstablefrom
MisRob:contributing-docs
Nov 28, 2023
Merged

Add contributing guidelines and organize developer documentation#4345
MisRob merged 5 commits intolearningequality:unstablefrom
MisRob:contributing-docs

Conversation

@MisRob
Copy link
Member

@MisRob MisRob commented Nov 27, 2023 •
edited
Loading

Summary

  • Adds CONTRIBUTING.md (including its copy in README.md)
  • Removes development related information from README.md in favor of adding index file and organizing all content into chapters of the development documentation directory
    • To make contributing guidelines visible
    • To make locating information easier
    • To align documentation structure with Kolibri and KDS
  • Also updates config.yml so that redirects to Discussions and LE forum are available when opening a new issue
    Screenshot from 2023-11-27 12-31-01 (screenshot from Kolibri)

Reviewer guidance

@MisRob
Move docs from readme to docs dir
ae1f6c4 
to make orientation easier and free up
a visible spot in the readme for the
contributing guidelines copy.

- Organizes content into chapters
- Adds index file
- Slightly tweaks some of the chapters titles
  and sections heading levels

Doesn't remove nor rewrites content.
@MisRob
Add contributing guidelines
d05b383
@MisRob
Add contact links to the new issue template
c809bd1
@MisRob MisRob marked this pull request as ready for review November 27, 2023 11:50
bjester
bjester approved these changes Nov 27, 2023
View reviewed changes
Copy link
Member

@bjester bjester left a comment

Choose a reason for hiding this comment

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

LGTM

@vkWeb
Copy link
Member

vkWeb commented Nov 27, 2023

I think we should annotate that the "With docker" setup is recommended from our side. From what I have observed, open source developers tend to use recommended methods, so that less issues pop up later down the road. Thoughts @bjester @MisRob ?

@bjester
Copy link
Member

bjester commented Nov 27, 2023

@vkWeb Yeah that is the recommended setup, so it's worthwhile to mention that

@MisRob
Copy link
Member Author

MisRob commented Nov 28, 2023

Thanks both, I mentioned that Docker setup is recommended in a few places. It's also the page where you will be taken from the contributing guidelines.

@MisRob MisRob merged commit 1974bfb into learningequality:unstable Nov 28, 2023
@MisRob MisRob deleted the contributing-docs branch November 28, 2023 16:17
@akolson akolson mentioned this pull request Aug 13, 2024
Merged
@akolson akolson mentioned this pull request Oct 1, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@bjester bjester bjester approved these changes

@marcellamaki marcellamaki Awaiting requested review from marcellamaki

Assignees

No one assigned

Labels

TAG: developer docs TODO: needs review

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@MisRob @vkWeb @bjester