improve info/ doc for contributors

equinor / gatsby-developer-portal

https://developer.equinor.com

MIT License

2 stars 2 forks source link

improve info/ doc for contributors #52

Open ingvald opened 5 years ago

ingvald commented 5 years ago

f.ex let main README have contributors as main target group
f.ex move some other tech info to other readmes or something (w/ link)
be able to run locally without token (inkl info/doc on it) -> already done?
be able to run locally without docker (incl info/ doc on it) -> esp b/c of windows vs docker?
...

cbuv commented 5 years ago

The main readme should describe how to use. e.g steps to install. Having a separate contributing document is fine as it is. Contributors are a subset of target group, like other open source projects.
other tech info in main readme? if so, which ones
documented in main readme.
not explicit documented, however, a normal npm install should work.

ingvald commented 5 years ago

Christoffer: notes captured after chat w/ Øyvind - let's talk :)

ingvald commented 5 years ago

f.ex let main README have contributors as main target group
- move current readme content to a separate maintainers readme/ md and link to it
move "contributing.md" content to main README
- add a bit (subtitle) for runing locally w/out tokens and without docker, see below

the run locally w/out tokens info...

...Omitting the tokens results in fonts missing and authors mocked (by empty image and a placeholder name).

Remove the @equinor-font dependency in package.json
npm install
npm run dev

cbuv commented 5 years ago

not sure if this is what you had in mind, browse b9dafa6 to see changes. Im a bit reluctant to move everything in contributing to README. Should really all content in contributing move to README?