GitHub pages mkdocs - Githubissues

TheDataShed / EngineeringHandbook

The source of truth for the engineering services

8 stars 2 forks source link

GitHub pages mkdocs #52

Closed KingMichaelPark closed 2 years ago

KingMichaelPark commented 2 years ago

This branch includes George's and my formatting changes branch:

Additions:

prettier formatting for markdown pre-commit hook
mkdocs material github pages site builder (Tags/search/abbreviations/logos/ etc..)

move standards up a level
fix broken links
add github actions for building the site

KingMichaelPark commented 2 years ago

Rebased with previous two merges that Roger merged yesterday

PsypherPunk commented 2 years ago

More of a question around the new structure: currently this repo. is the Handbook. However, with the additional changes and shifting the contents, this is now a build repository for something else (i.e. the GitHub Pages) which would effectively become the Handbook.

Are we okay with that? Any proponents of the existing layout? Or could we have both (e.g. keep this repo. but have a separate one which pulls in this as a Git submodule in its own docs/ directory)?

PsypherPunk commented 2 years ago

Follow up to my earlier comment: discussed this offline and we're comfortable with the approach.

it'd be good to know how we could leverage the separate build process to keep some pages private while publishing those we're happy with—any ideas on this, @KingMichaelPark?
while this is private, all should be okay; however, if/when this goes public, we'll have to loop Marketing in as we're now producing a styled, branded product.

Other than that, good to go.