add readme
ClosedPublic

Authored by zzag on Feb 20 2018, 12:18 PM.

Details

Reviewers
fabianr
romangg
Summary

Explain how to setup dev environment and build the website.

Depends on D10677

Diff Detail

Repository
R985 KDE Human Interface Guidelines
Branch
readme
Lint
No Linters Available
Unit
No Unit Test Coverage
zzag requested review of this revision.Feb 20 2018, 12:18 PM
zzag created this revision.
zzag edited the summary of this revision. (Show Details)Feb 20 2018, 12:19 PM
zzag added a dependency: D10677: add requirements.txt.

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?

zzag added a comment.Feb 20 2018, 10:07 PM

Oh, I've forgot the part about getting the source code...

zzag added a comment.Feb 20 2018, 10:26 PM

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:

  • leave readme as it is
  • on the contribute page, add several words about how people help by contributing and add link to the readme file
zzag updated this revision to Diff 27643.Feb 20 2018, 10:30 PM

add getting the source code section

zzag updated this revision to Diff 27644.Feb 20 2018, 10:35 PM

copy contributing section from resources/contribute.rst

zzag updated this revision to Diff 27645.Feb 20 2018, 10:38 PM

fix link

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.

zzag added inline comments.Feb 21 2018, 3:02 PM
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)

fabianr accepted this revision.Feb 22 2018, 8:03 AM
This revision is now accepted and ready to land.Feb 22 2018, 8:03 AM
zzag closed this revision.Jun 2 2018, 7:54 PM