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

Documentation Maintainability with WordPress. Jekyll? #23

Closed
justingeeslin opened this issue Jun 12, 2020 · 2 comments
Closed

Documentation Maintainability with WordPress. Jekyll? #23

justingeeslin opened this issue Jun 12, 2020 · 2 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@justingeeslin
Copy link
Member

At first I thought it would be a good idea to make a beautiful documentation site consolidating all the docs for the various sources around the web in a Wordpress site and putting a static version of the site in the docs folder to be served out by GitHub pages.

But from a community maintainability perspective, this might not be viable. How will others edit these HTML files, and once they do how would I pull back in their changes in to the Wordpress site from which I'm generating the docs?

I'm not familiar with what GitHub Pages recommends, Jekyll. I may give it a shot in the name of community maintainability. The idea is that the docs can stay markdown and GH Pages will generate the HTML version to be consumed by the browser.

@justingeeslin justingeeslin added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers labels Jun 12, 2020
@justingeeslin
Copy link
Member Author

Make progress creating a more maintainable documentation site using GitHub's Pages feature / Jekyll. PR coming soon.

@justingeeslin
Copy link
Member Author

#26 Fixes this issue; now we can all collaborate on plain-text, markdown files for documentation that is kept in-branch.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant