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

docs: MkDocs use of snippets for README, CONTRIBUTING, LICENSE #305

Open
1 task
fyliu opened this issue Jun 10, 2024 · 0 comments
Open
1 task

docs: MkDocs use of snippets for README, CONTRIBUTING, LICENSE #305

fyliu opened this issue Jun 10, 2024 · 0 comments
Labels
complexity: small All steps are laid out in detail so that someone new to the project can work on it feature: docs: team guide Same as PD team documentation? role: technical writing s: PD team stakeholder: People Depot Team size: 0.25pt Can be done in 0.5-1.5 hours

Comments

@fyliu
Copy link
Member

fyliu commented Jun 10, 2024

Overview

We need to document how we set up the project so that contents exist in a single location but satisfies both Github and MkDocs requirements that they be in different places. It's through MkDocs snippets.

Action Items

  • add documentation for snippets and how we use it in the project documentation

Resources/Instructions

  • we keep the content files in the project root and use snippets inside the docs/ directory so to keep MkDocs happy
  • The LICENSE file exists in upper and lowercase intentionally. There's places that need both.
@fyliu fyliu added s: PD team stakeholder: People Depot Team feature: docs: team guide Same as PD team documentation? size: 0.25pt Can be done in 0.5-1.5 hours role: dev lead ready for product labels Jun 10, 2024
@fyliu fyliu added this to the 5 - Team Workflow milestone Jun 10, 2024
@github-project-automation github-project-automation bot moved this to New Issue Review in P: PD: Project Board Jun 10, 2024
@ExperimentsInHonesty ExperimentsInHonesty moved this from New Issue Review to Prioritized Backlog in P: PD: Project Board Jun 24, 2024
@fyliu fyliu added complexity: small All steps are laid out in detail so that someone new to the project can work on it role: technical writing and removed complexity: missing role: dev lead labels Aug 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
complexity: small All steps are laid out in detail so that someone new to the project can work on it feature: docs: team guide Same as PD team documentation? role: technical writing s: PD team stakeholder: People Depot Team size: 0.25pt Can be done in 0.5-1.5 hours
Projects
Status: 📋Prioritized Backlog
Development

No branches or pull requests

2 participants