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

.github/ISSUE_TEMPLATE.md

@@ -1,13 +1,12 @@
-# _TASK or Feature_
-### Request or User Story
+<!-- Fill out the appropriate template and delete nonappicable lines -->
 
+## Feature Request or Task
+### User Story / Description
 ### Definition of Done
 
-### Notes
-
-# _BUG_
-### Current/Expected Behavior
-
-### Additional Info (steps to replicate, device/browser, helpful links)
-
-### Screenshots
+-------
+## Bug Report
+### Current Behavior
+### Expected Behavior
+### Mobile & Desktop Screenshots/Recordings
+### Additional Info (device/browser, helpful links)

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,17 @@
+<!--- Prepend PR title with [WIP] if work in progress. Remove when ready for review. -->
+
+## What type of PR is this? (check all applicable)
+- [ ] Refactor
+- [ ] Feature
+- [ ] Bug Fix
+
+## Description
+## Related Tickets & Documents
+## Mobile & Desktop Screenshots/Recordings (if there are UI changes)
+## Added to documentation?
+  - [ ] docs.dev.to
+  - [ ] readme
+  - [ ] no documentation needed
+
+## [optional] What gif best describes this PR or how it makes you feel?
+![alt-text](gif-link)

README.md

@@ -55,6 +55,7 @@ Welcome to the [dev.to](https://dev.to) codebase. We are so excited to have you.
   - [Starting the application](#starting-the-application)
   - [Suggested Workflow](#suggested-workflow)
 - [Additional docs](#additional-docs)
+- [Product Roadmap](#product-roadmap)
 - [Core Team Members](#core-team)
 - [License](#license)
 
@@ -74,10 +75,10 @@ TODO: update link ^
 
 ### How to contribute
 1. Fork the project & clone locally. Follow the initial setup [here](#getting-started).
-2. Create a feature branch: `git checkout -b feature/that-new-feature`
+2. Create a branch, naming it either a feature or bug: `git checkout -b feature/that-new-feature` or `bug/fixing-that-bug`
 3. Code and commit your changes. Bonus points if you write a [good commit message](https://chris.beams.io/posts/git-commit/): `git commit -m 'Add some feature'`
 4. Push to the branch: `git push origin feature/that-new-feature`
-5. [Create a pull request](#create-a-pull-request) for your feature branch 🎉
+5. [Create a pull request](#create-a-pull-request) for your branch 🎉
 
 ### Contribution guideline
 
@@ -179,6 +180,18 @@ Caveat: `bin/rspec` is not equipped with Spring because it affects Simplecov's r
 ## Additional docs
 [Check out our dedicated docs page for more technical documentation.](https://docs.dev.to)
 
+## Product Roadmap
+
+Our new product roadmap can be found [here](https://github.com/thepracticaldev/dev.to/projects/1). Many notes need to be converted to issues but this should provide an overview of features we plan to work on, as well as features we are considering.
+
+Core team members will move issues along the project board as they progress.
+
+- Ideas & Requests: features up for discussion.
+- Needs Owners: features in need of an owner.
+- Committed: features we're committed to building -- free for contributors to work on, but please communicate with the owner beforehand.
+- In Progress (early stage): work has begun on feature.
+- In Progress (late stage): feature is near completion.
+
 ## Core team
 
 - [@benhalpern](https://dev.to/ben)

docs/.gitdocs.json

@@ -1,7 +1,8 @@
 {
-  "name": "dev.to Docs",
+  "name": "DEV Docs",
   "root": "./",
   "logo": "devblacksquarelogo.svg",
+  "favicon": "favicon-32x32.png",
   "header_links": [
     {
       "title": "Repo",

docs/additional-postgres-setup.md

@@ -1,16 +1,18 @@
-# Setup your application with PostgreSQL -
+# Setup your application with PostgreSQL
 Follow these links for detailed the installation guide.
-1. Mac OS - [setup](https://postgresapp.com/)
-2. Linux / Ubuntu -
-   - Ubuntu `14.04` - [setup](https://www.digitalocean.com/community/tutorials/how-to-install-and-use-postgresql-on-ubuntu-14-04)
-   - Ubuntu `16.04 and higher` - [setup](https://www.digitalocean.com/community/tutorials/how-to-install-and-use-postgresql-on-ubuntu-16-04)
-3. Windows - [setup](https://www.postgresql.org/download/windows/)
+
+1. [Mac OS](https://postgresapp.com/)
+2. Linux / Ubuntu
+   - [Ubuntu `14.04`](https://www.digitalocean.com/community/tutorials/how-to-install-and-use-postgresql-on-ubuntu-14-04)
+   - [Ubuntu `16.04 and higher`](https://www.digitalocean.com/community/tutorials/how-to-install-and-use-postgresql-on-ubuntu-16-04)
+3. [Windows](https://www.postgresql.org/download/windows/)
 
 ##### You can find all installation packages for different operating systems [here](https://www.postgresql.org/download/).
 
-##### After installation -
+##### After installation
 1. If your Rails app is unable to connect to the PostgreSQL, then update your `database.yml` file with `username` and `password`.
-```ruby
+
+```yaml
 development:
     <<: *default
     username: POSTGRESSQL_USERNAME
@@ -20,9 +22,10 @@ test:
     username: POSTGRESSQL_USERNAME
     password: POSTGRESSQL_PASSWORD
 ```
+
 2. While running test cases, if you get an error message `postgresql connection timeout`. Go to your `spec/support/database_cleaner.rb` file. And rename `:truncation` with `:deletion`.
 
-##### Note -
+##### Notes
 1. Don't forget to set up your PostgreSQL with `username` and `password`.
 2. Don't commit your `database.yml` or `database_cleaner.rb` files. Or PostgreSQL `username` and `password` to any repository.
 3. You can use environment variables for storing `username` and `password`. You can define them inside the `application.yml` file.

docs/addl-tech.md

@@ -0,0 +1,25 @@
+## 🔑 Key App tech/services
+
+* We use [_Puma_](https://github.com/puma/puma) for the server
+* We [rely heavily on edge caching](https://dev.to/ben/making-devto-insanely-fast) with _Fastly_
+* We use _Cloudinary_ for image manipulation/serving
+* We use _Keen_ for event storage
+* We use _Airbrake_ for error monitoring
+* We use _Timber_ for logging
+* We use [_Delayed Job_](https://github.com/collectiveidea/delayed_job) for background workers
+* We use _Algolia_ for search
+* We use [_Redcarpet](https://github.com/vmg/redcarpet) and [Rouge_](https://github.com/jneen/rouge) for Markdown
+* We use _[Carrierwave](https://github.com/carrierwaveuploader/carrierwave)/Fog/AWS S3_ for image upload/storage
+* We use a modified version of [_InstantClick_](http://instantclick.io/) instead of _Turbolinks_
+* We are hosted on _Heroku_
+* We use _Heroku scheduler_ for scheduled jobs (default)
+* We use _Sendgrid_ for API-triggered mailing
+* We use _Mailchimp_ for marketing/outreach emails
+* We use [_Figaro_](https://github.com/laserlemon/figaro) for app configuration.
+* We use [_CounterCulture_](https://github.com/magnusvk/counter_culture) to keep track of association counts (counter caches)
+* We use [_Rolify_](https://github.com/RolifyCommunity/rolify) for role management.
+* We use [_Pundit_](https://github.com/varvet/pundit) for authorization.
+* We use Service Workers to proxy traffic
+* We use Preact for some of the front end. See [Frontend](/frontend) for more info
+
+_This list is non-exhaustive. If you see something that belongs here, feel free to add it._

docs/faq.md

@@ -2,7 +2,11 @@
 
 Get started with our [`README`](https://github.com/thepracticaldev/dev.to). You can visit this set of docs for more details when you're up and running.
 
-## I'm getting an error [ERROR-SOMETHING-WENT-WRONG]. Where do I report it?
+## Actually, I meant how to contribute to these cool docs!
+
+All documentation lives in the [docs folder](/docs). Any guides and clarifications are very much welcome.
+
+## I'm getting an error [SOME-ERROR]. Where do I report it?
 
 You can [write a new issue](https://github.com/thepracticaldev/dev.to/issues/new) and let us know what exactly what went wrong. We'll be able to help you debug if we have specific information, the context of how the error happened, and any other information you think would help.
 
@@ -12,7 +16,7 @@ Unfortunately, the core team develops only macOS right now. We don't have guidel
 
 - Ruby
 - Ruby on Rails
-- [PostgreSQL](https://www.postgresql.org/download/)
+- [PostgresSQL](/additional-postgres-setup)
 - [Yarn](https://yarnpkg.com/en/docs/install)
 
 You can use a guide like [GoRails](https://gorails.com/setup/), but since we have not tried it ourselves we can't fully endorse it. Let us know how it goes, or if you have tips or experience setting all this up! We're open to including guides for other operating systems.

docs/frontend.md

@@ -1,6 +1,15 @@
 ## ⚛ Front-End Development
 
-There is some legacy code which is old school JS, but for all things new, [Preact](https://preactjs.com) is the where it's at. If you're new to Preact, check out their [documentation](https://preactjs.com/guide/getting-started). Also, consider following the [#preact](https://dev.to/t/preact) tag on [dev.to](https://dev.to).
+Before doing any development in the front-end, ensure that [Node.js](https://nodejs.org) is installed. To install Node.js, you can do one of the following:
+
+* [Download and install the LTS version](https://nodejs.org/en/download), or
+* [Download and install nvm](https://github.com/creationix/nvm) and follow their instructions to install the Node.js LTS version (recommended), or
+* [Download and install n](https://github.com/tj/n)and follow their instructions to install the Node.js LTS version, or
+* Install Node.js via Homebrew (macOS only) `brew install node`
+
+For bundling, we use Webpack via the [webpacker](https://github.com/rails/webpacker) since the backend is Ruby on Rails.
+
+There is some legacy code which is old school JS, but for all things new, [Preact](https://preactjs.com) is where it's at. If you're new to Preact, check out their [documentation](https://preactjs.com/guide/getting-started). Also, consider following the [#preact](https://dev.to/t/preact) tag on [dev.to](https://dev.to).
 
 ### 👷‍ Building components
 

docs/license-faq.md

@@ -1,12 +1,18 @@
+DEV is licensed under the [GNU Affero General Public License 3 (AGPL-3)](https://gnu.org/licenses/agpl-3.0.html).  Please see the LICENSE file in our repository for the full text.
+ 
+Like many open source projects, we require that contributors provide us with a Contributor License Agreement (CLA).  By submitting code to the DEV project, you are granting us a right to use that code under the terms of the CLA.
+ 
+Our version of the CLA was adapted from the Microsoft Contributor License Agreement, which they generously made available to the public domain under Creative Commons CC0 1.0 Universal.
+
 ### Where can I learn more about the AGPL-3 license?
 
-Please refer to the official “Why the Affero GPL” and the FAQ page on GNU.org for full details regarding this license.
+Please refer to the official “[Why the Affero GPL](https://www.gnu.org/licenses/why-affero-gpl.html)” and the [FAQ page](https://www.gnu.org/licenses/gpl-faq.html) on [GNU.org](https://www.gnu.org) for full details regarding this license.
 
 ### Why does DEV have a CLA?
 
 The Contributor License Agreement (CLA) is a legal document in which you state that you are entitled to contribute your code to the DEV codebase, and are willing to have it used in distributions and derivative work.
 
-The CLA helps provide confidence to future users that will be allowed to use the DEV codebase without fear that a contributor will try to withdraw permissions at a later date.
+The CLA helps provide confidence to future users that they will be allowed to use the DEV codebase without fear that a contributor will try to withdraw permissions at a later date.
 
 ### Am I giving away the copyright of my contributions?
 

docs/readme.md

@@ -6,10 +6,16 @@ items:
     title: Testing
   - path: frontend.md
     title: Frontend
+  - path: addl-tech.md
+    title: Key App Tech & Services
+  - path: additional-postgres-setup.md
+    title: Additional PostgreSQL Setup (for non-macOS)
   - path: helpful-hints.md
     title: Random Helpful Things
   - path: faq.md
     title: FAQ
+  - path: license-faq.md
+    title: License FAQ
 ---
 # Welcome to the dev.to documentation!
 _If you're viewing this on GitHub, we recommend viewing our docs on our static page: [docs.dev.to](https://docs.dev.to)_
@@ -19,3 +25,5 @@ This is the home of the nitty-gritty technical details for contributing to dev.t
 If you're looking to get started, check out our [`README` in the main repo.](https://github.com/thepracticaldev/dev.to)
 
 Have any questions, comments, or concerns? Check out our [FAQ](faq), or ask for help in our [help thread on dev.to](#todo)!
+
+TODO: Update oss help thread link

netlify.toml

@@ -8,5 +8,26 @@
 [build]
   base = "docs/"
 [[redirects]]
-  from = "http://devto.netlify.com/*"
+  from = "http://docs.dev.to"
   to = "https://docs.dev.to"
+[[redirects]]
+  from = "http://docs.dev.to/*"
+  to = "https://docs.dev.to/:splat"
+[[redirects]]
+  from = "docs.dev.to"
+  to = "https://docs.dev.to"
+[[redirects]]
+  from = "docs.dev.to/*"
+  to = "https://docs.dev.to/:splat"
+[[redirects]]
+  from = "http://devto.netlify.com"
+  to = "https://docs.dev.to"
+[[redirects]]
+  from = "http://devto.netlify.com/:splat"
+  to = "https://docs.dev.to/:splat"
+[[redirects]]
+  from = "https://devto.netlify.com"
+  to = "https://docs.dev.to"
+[[redirects]]
+  from = "https://devto.netlify.com/*"
+  to = "https://docs.dev.to/:splat"