Skip to content

A site grid gatekeeper technology based solely on Condor components

License

Notifications You must be signed in to change notification settings

htcondor/htcondor-ce

 
 

Repository files navigation

HTCondor-CE Documentation

Deploy static MkDocs pages Valdate static MkDocs pages


Source documents and MkDocs configuration for http://htcondor-ce.org served by GitHub Pages. The documentation is built using the mkdocs-material container with a GitHub Action.

Previewing the Pages

To preview the pages, start a MkDocs development server. The development server will automatically detect any content changes and make them viewable in your browser.

  1. cd into the directory containing the local clone of your GitHub fork

  2. Start a MkDocs development server to preview your changes:

     $ docker run --rm -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material:7.1.0
    

    To preview your changes visit localhost:8000 in the browser of your choice. The server can be stopped with Ctrl-C.

Contributing Documentation

To contribute changes to the documentation, please submit a pull request. The reason for this is two-fold: document and link validation CI checks are run on pull requests and anything pushed to the docs branch is immediately published to http://htcondor-ce.org.