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

move documentation from wiki to /docs folder #43

Closed
mrothauer opened this issue Mar 26, 2017 · 1 comment
Closed

move documentation from wiki to /docs folder #43

mrothauer opened this issue Mar 26, 2017 · 1 comment

Comments

@mrothauer
Copy link
Member

mrothauer commented Mar 26, 2017

the master branch can be configured to show content of /docs folder automatically on
http://foodcoopshop.github.io/foodcoopshop

how this works is described here:
https://help.github.com/articles/user-organization-and-project-pages/

reason for the change is that users need to be granted write permissions to be able to change wiki pages. if the documentation is moved to /docs, pull requests can be done by anyone by creating a pull request from a fork

another reason is the increased flexibility (eg. integration of new languages, make a dynamic table of contents...

tasks

question

  • as the master branch's /docs folder is taken for the build of the gh pages url, how to view changes on develop branch? maybe it's enough to view the code, but there will be no built version of the docs
@mrothauer mrothauer self-assigned this May 9, 2017
@mrothauer mrothauer moved this from planned issues to in progress in Roadmap v1.3 (Summer Release 2017) May 9, 2017
@mrothauer
Copy link
Member Author

the new documentation can be found here: https://foodcoopshop.github.io/. it's mobile friendly and the implementation is a good solution for the demands of foodcoopshop. the source code can be found in an own repository (https://github.com/foodcoopshop/foodcoopshop.github.io) where future devs or maintainers can update via pull request.

@mrothauer mrothauer moved this from in progress to finished and merged into develop in Roadmap v1.3 (Summer Release 2017) May 15, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
Roadmap v1.3 (Summer Release 2017)
finished and merged into develop
Development

No branches or pull requests

1 participant