Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Update Contributing.md and ReadMe.md #183

Open
1 of 10 tasks
theecrit opened this issue Jun 2, 2021 · 0 comments
Open
1 of 10 tasks

Update Contributing.md and ReadMe.md #183

theecrit opened this issue Jun 2, 2021 · 0 comments
Labels
documentation maintaining or creating documentation about the project needs definition Issue needs more details to be ready for implementation

Comments

@theecrit
Copy link
Collaborator

theecrit commented Jun 2, 2021

What are you submitting?

Place an x in the appropriate bracket:

  • Bug (something's broken)
  • Feature request or improvement
  • Content update
  • Question
  • Other

Description

Currently, the ReadMe.md and Contributing.md files include some inaccuracies and omissions.

Contact info

  • ReadMe.md contact section should be replaced with:

Contact the team

  • Contributing.md

Misc.

  • Remove "Additional project information" section, as it's out of date.
  • Add instructions for updating nav menu via _config.yml and navigation.yml (plus note that seeing changes requires rebuilding the site locally).
  • Add instructions for calendar events:

Managing the /calendar section

  • Events listed on the embedded Google Calendar are tied to the administrator@openoakland.org account. To add or edit an event, send a request to steering@openoakland.org.
  • To add an event to the Past Events section, follow the commented instructions in /src/_data/calendar.yml.
Thank you!
@theecrit theecrit added documentation maintaining or creating documentation about the project needs definition Issue needs more details to be ready for implementation labels Jun 2, 2021
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
documentation maintaining or creating documentation about the project needs definition Issue needs more details to be ready for implementation
Projects
None yet
Development

No branches or pull requests

1 participant