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

General doc update of the repo #2148

Open
MTRNord opened this issue Jan 26, 2024 · 2 comments · May be fixed by #2155
Open

General doc update of the repo #2148

MTRNord opened this issue Jan 26, 2024 · 2 comments · May be fixed by #2155
Assignees
Labels
enhancement This would be an improvement to the website.

Comments

@MTRNord
Copy link
Collaborator

MTRNord commented Jan 26, 2024

Things that would be nice to have:

  • Where do you put posts
  • Where to put media
  • Which shortcodes are available and used?
  • Which conventions are expected for blog posts
@MTRNord MTRNord added the enhancement This would be an improvement to the website. label Jan 26, 2024
@thibaultamartin
Copy link
Contributor

thibaultamartin commented Jan 31, 2024

We indeed are lacking such information! It would make life easier for people contributing content to the website.

We might also want to add information about how we're using and building the website: what is driving decisions, where are decisions taken, what are we trying to achieve with the website, how we measure progress, how to get involved.

I think this could take the form of:

  • Creating a PUBLISHING.md for people who want to add content to the website
  • Creating a CONTRIBUTING.md for people who want to open issues, open PRs, and more generally get involved in helping getting the site in a good shape
  • Updating the README.md to point to those files

@thibaultamartin thibaultamartin self-assigned this Jan 31, 2024
@thibaultamartin thibaultamartin linked a pull request Jan 31, 2024 that will close this issue
14 tasks
@thibaultamartin
Copy link
Contributor

This talk from SoOCon is an interesting reference

https://noti.st/lornajane/5pGyBS#st9onZP

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement This would be an improvement to the website.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants