Explain how to setup dev environment and build the website.
Depends on D10677
No Linters Available |
No Unit Test Coverage |
Adding a Readme makes sense. We currently have some information on how to obtain and compile the HIG source code in the HIG document at:
https://phabricator.kde.org/source/websites-hig-kde-org/browse/master/source/resources/contribute.rst
I think it makes more sense in the HIG for people who only know the published HIG, but not the repo. Maybe put it a bit less exposed later on (About category on top level of the HIG and then Contribute subcategory). In the Readme could be a link to this HIG page for instructions instead of duplicating them in the Readme.
@fabianr: Your opinion?
I think it makes more sense in the HIG for people who only know the published HIG, but not the repo. Maybe put it a bit less exposed later on (About category on top level of the HIG and then Contribute subcategory). In the Readme could be a link to this HIG page for instructions instead of duplicating them in the Readme.
The problem with "Contribute" pages is that most devs follow the best practice: skip planning/reading docs and jump directly to the coding. At least there should be some useful readme file.
So, I propose:
I think the main page how to contribute should be the contribute.rst one. Readme's tend to be pretty intimidating for designers, but I'm fine with also having a README.md for developers
README.md | ||
---|---|---|
65 | You don't need to run an web server. Sphinx creates static html pages, you can just open them in the browser. |
README.md | ||
---|---|---|
65 | Well, yes, you're right. You could just open index.html in a file manager, but most people use local development servers. (and in some cases file:// breaks things) |