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

Guide for pure local MkDocs setup #380

Open
2 tasks
fyliu opened this issue Sep 16, 2024 · 0 comments
Open
2 tasks

Guide for pure local MkDocs setup #380

fyliu opened this issue Sep 16, 2024 · 0 comments
Labels
complexity: medium draft This issue is not fully-written feature: docs: team guide Same as PD team documentation? feature: process improvement ready for dev lead role: dev lead s: PD team stakeholder: People Depot Team size: 1pt Can be done in 4-6 hours

Comments

@fyliu
Copy link
Member

fyliu commented Sep 16, 2024

Overview

For pure docs contributors, we need a shortest path guide for getting mkdocs running locally that doesn't care about setting up the code.

Action Items

  • Figure out the better way to set up a local mkdocs
  • Create the guide

Resources/Instructions

  • I recommended doing this with the uv tool. The advantages are:
    1. It doesn't require an existing python
    2. It sets up its own python environment
    3. It provides simple commands to set things up
  • We'll need instructions for different platforms or link to those instructions
  • we might not need docker, and that's the preferred way since there's less extra software running in the background
  • pre-commit with the mdformat settings is preferred
  • mkdocs 1.6 with the extra validation is preferred
  • need to make sure required mkdocs plugins are available in the environment
  • A simple git usage guide or outline that links to other documents would be helpful. The conflict resolution docs needs to be easy to understand.
@fyliu fyliu added size: 1pt Can be done in 4-6 hours feature: process improvement s: PD team stakeholder: People Depot Team feature: docs: team guide Same as PD team documentation? draft This issue is not fully-written role: dev lead ready for dev lead complexity: medium labels Sep 16, 2024
@fyliu fyliu added this to the 5 - Team Workflow milestone Sep 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
complexity: medium draft This issue is not fully-written feature: docs: team guide Same as PD team documentation? feature: process improvement ready for dev lead role: dev lead s: PD team stakeholder: People Depot Team size: 1pt Can be done in 4-6 hours
Projects
Status: 🆕New Issue Review
Development

No branches or pull requests

1 participant