Commit graph

21 commits

Author SHA1 Message Date
Jacob Herrington
a63a11f930 Write docs on rolify admin workaround [ci skip] (#5078) 2019-12-13 08:23:55 -05:00
Jacob Herrington
7d0aeeefe5 Improve the clarity of the docs and fix Prettier config (#4899)
* Improve format and clarity of the docs [ci skip]

While this change produces a lot of git noise by enacting what seems
like an arbitrary linewrap on most of the files in the documentation it
will result in better version control and tracking of the changes in the
documentation.

For example, as it currently stands, if one was to make a
PR to move a comma in a sentence because each paragraph in most of the
files is on a single line, that small change would look in the git
history like the author had modified the entire paragraph. In reality,
this author just moved a comma.

This change also includes a significant number of modifications to the
more article-esque docs. Many of these docs were written in a sort of
stream-of-conciousness and aren't as easy to read as they could be.
Hopefully this is the first of several readability changes. If we could
get these docs to a more accessible reading level, we would probably see
an increase in contributions. :)

* Delegate markdown wrapping to Prettier

* Add linewrapping explanation in the docs [ci skip]
2019-11-26 08:40:53 -05:00
rhymes
1924a77a10 [DOC] Move architecture to technical overview (#4746) 2019-11-07 14:28:23 -05:00
Ron Tal
e226a8e70d removed irrelevant word from docs (#4601) 2019-10-26 12:15:13 -04:00
Mac Siri
ba82deca90
Create doc on deployment CI/CD process (#4563) [ci skip] 2019-10-24 15:24:02 -04:00
Emilia Muresan
daff71321f Fix lints in app/javascript/src/components/ (#4261) [ci skip] 2019-10-15 16:11:18 -04:00
Jacob Herrington
691faf78ac Update the docs readme with instructions [ci skip] (#4361)
The readme should include instructions to run the docs site so that
people don't have to go searching for the contributing.md file if they
are stumbling upon the docs in their code editor instead of via the
docs.dev.to website.
2019-10-14 09:24:46 -04:00
Jacob Herrington
4ea1e6e020 Fix typos and mechanical mistakes (#4177) [ci skip] 2019-10-01 16:30:13 -04:00
rhymes
35526bef9b API: OpenAPI 3 spec and auto generated docs (#3650) 2019-08-12 11:36:04 -04:00
rhymes
9210f6793b Improvements on dev docs (#2616)
* Correct installation documentation

* Add stylized titles

* Add some changes to the getting started documentation

* Add changes for the backend guide

* Add changes for the design guide

* Add testing / Q&A guide improvements

* Minor fixes to contributing docs

* More improvements to the general doc

* Improvements for frontend guide
2019-04-29 18:54:29 -04:00
Andrew Brown
30dcb23169 #2507 - refactor GitDocs documentation (#2595)
* #2507 - refactor GitDocs documentation

* #2507 - fix grammar and spelling errors
2019-04-29 10:08:22 -04:00
Nathan Sebhastian
5f051d9512 Add maintaining your fork to docs (#742) [ci skip] 2019-01-16 14:48:38 -05:00
Peter Frank
5255078475 Add hosting your own instance info to Docs (#633)
Added a new page to the Docs re: eventually standing up your own
version of DEV
2018-09-12 14:37:28 -04:00
Peter Frank
a3dbc246e5 Add design guidelines to docs (#422)
* Add design guidelines to docs

Design inspiration, notes, and acknowledgments

* Update design guideline wording
2018-08-24 15:39:18 -04:00
Jess Lee
8c695378c5 Add issue levels doc (#414) 2018-08-22 12:48:45 -04:00
Mac Siri
7e88a3b57f Expend installation docs (#366)
* Update Travis's Slack config

* Fix styling

* Update prerequisites

* Update prerequisites

* Update README

* Expand installation docs

* Specify minimum Postgres version [ci skip]

* Change specified PostgreSQL version

* Update netlify.toml

* Update schema

* Update algolia links [ci skip]

* Update installation docs

* Remove TODO

* Update installation path/title

* Update top level installation guide

* Change installations directory name

* Rename installations to installation in docs

* Fix headline typo

* Add liquid tags and adjust main readme
2018-08-16 15:52:56 -04:00
Nick Taylor
01d5ec0fa2 Task/prettier for markdown (#335) [ci skip]
* Added prettier for markdown files on precommit.

* Ran prettier on markdown files.

* Fixed wording as per PR comment.

* Got rid of the double vision on "the". 🙃
2018-08-13 18:04:26 -04:00
Peter Frank
47cdff61a0 Fix links in Docs (#280)
- Changed a few relative links to absolute links
2018-08-08 14:29:15 -04:00
Andy Zhao
6da3684705 [ci skip] Add help thread to docs/readme (#276) 2018-08-08 13:22:44 -04:00
Andy Zhao
40f4997199 Update README/Docs (#670)
* Rename and add addl postgres setup

* Update ToC for docs/readme

* Add links + enrich license FAQ page (#671)

- Added brief "intro" section at the top
- Added back in links that were lost in copy/paste over

* Nick/task/update front end docs [skip ci]

* Clarify that each step is an or

* issue/pr templates

* Remove broken redirect from netlify

* Attempt to add redirects for Netlify

* Try to fix redirects for Netlify

* Added more redirects for netlify

* Fix redirects to use splat keyword

* Testing placeholder instead of splat

* add product roadmap

* Change doc contribution instructions

* Add notice at bottom
2018-08-08 12:40:20 -04:00
Mac Siri
243c44e23d Update Docs [ci skip] (#656)
* Move frontend doc [ci skip]

* Fix DEV styling [ci skip]

* Update table of contents [ci skip]

* Move stuffs around [ci skip]

* Move stuffs around [ci skip]

* Add gitdocs integration

* Mess with title again [ci-skip]

* Add root readme back in

* Update docs/readme as a new readme

* Messing with title again

* Add where to get help [ci skip]

* Fix dev connect link [ci skip]

* Move how to get help [ci skip]

* Add TODO to empty headers

* Add more TODOs and clean up a link

* Add sloan

* Update prereqs to specify we use macOS

* Add gitdocs build to test on Netlify

* Update README [ci skip]

* Add .gitdocs_build/ to .gitignore [ci skip]

* Create netlify.toml

* Update docs with logo and more docs

* Update gitdocs name

* Add redirects for netlify

* Remove extraneous redirects from netlify

* Add more README TODOs [ci skip]

* Update root directory of gitdocs

* Move ISSUE_TEMPLATE to .github/ [ci skip]

* Testing new base for netlify

* Update README [ci skip]

* Rename index.md to readme.md for GitHub

* Move gitdocs.json to docs folder

* Add GPL LICENSE [ci skip]

* tweak readme

* update license language

* Update FAQ with some Q and A

* Add some traffic control for docs readme

* add license faq and core team members

* Add new line to fix list

* Add AGPL-3

Adding the GNU AFFERO GENERAL PUBLIC LICENSE.

* Update GPL License

* Additional documentation for PostgreSQL setup
2018-08-08 10:36:32 -04:00