docbrown/docs
Nick Taylor 86eb75cee7
Report a Message in Connect (#12229)
* Frontend Ready for Connect Report Abuse

* add feedback api

* js defination fix

* Added Hooks to the Component

* add json response in feedback

* Block popup added

* fix render issue

* Made changes in internal view

* change error message

* Added few design changes =

* add test cases

* Update app/javascript/chat/actions/requestActions.js

Co-authored-by: Nick Taylor <nick@iamdeveloper.com>

* add PR suggestions

* add backend test cases

* report abuse form close

* Update app/javascript/chat/actions/requestActions.js

Co-authored-by: Nick Taylor <nick@iamdeveloper.com>

* Update app/javascript/chat/ReportAbuse/index.jsx

Co-authored-by: Nick Taylor <nick@iamdeveloper.com>

* add test cases

* Update app/javascript/chat/ReportAbuse/index.jsx

Co-authored-by: Nick Taylor <nick@iamdeveloper.com>

* Update app/javascript/chat/ReportAbuse/index.jsx

Co-authored-by: Marcy Sutton <holla@marcysutton.com>

* Update app/javascript/chat/ReportAbuse/index.jsx

Co-authored-by: Marcy Sutton <holla@marcysutton.com>

* group the fieldset

* fix report abuse api

* fix test case

* fix request test case

* fix typo

* cleaned up markup in report abuse component.

* Fixed spacing between abuse options.

* Fixed wording in report abuse confirmation.

* Removed unnecessary data-testid and aria-label attributes.

* Added some top margin to the report abuse form.

* Update app/javascript/chat/message.jsx

Co-authored-by: Suzanne Aitchison <suzanne@forem.com>

* Added a legend to the the fieldset.

* Update app/javascript/chat/actions/requestActions.js

Co-authored-by: Michael Kohl <citizen428@dev.to>

Co-authored-by: Sarthak <7lovesharma7@gmail.com>
Co-authored-by: Narender Singh <narender2031@gmail.com>
Co-authored-by: Marcy Sutton <holla@marcysutton.com>
Co-authored-by: Suzanne Aitchison <suzanne@forem.com>
Co-authored-by: Michael Kohl <citizen428@dev.to>
2021-01-19 12:07:47 -05:00
..
.static Update more Forem to DEV language (#9337) 2020-07-15 18:01:34 -04:00
admin Renamed internal.js pack file to admin.js (#11046) 2020-10-23 17:57:39 -04:00
backend Remove CacheBuster (#12080) 2020-12-30 11:55:16 -05:00
contributing 🚀 Ability to allow tag moderators to create chat channels (#9741) 2020-12-08 13:10:36 +07:00
creators Fix a typo caused by markdown (#9995) 2020-08-25 15:41:59 -04:00
design Add initial language doc page (#9653) 2020-08-06 14:46:04 -04:00
frontend Added webpack bundle analyzer (#12013) 2020-12-22 19:13:40 -05:00
getting-started Document the advanced startup setup (#11915) 2020-12-16 18:13:57 +01:00
installation Recommend Redis 6 for Forem self installation (#11473) 2020-11-18 17:05:00 +01:00
maintainers Feature:Deploy Forem to DEV on every merge (#11148) 2020-10-30 13:08:16 -05:00
technical-overview Report a Message in Connect (#12229) 2021-01-19 12:07:47 -05:00
tests Start a11y testing checklist in Forem docs (#11614) 2020-11-25 14:22:50 -05:00
.gitdocs.json Updated gitdocs.json links to https (#11118) 2020-10-27 12:19:03 -04:00
.nvmrc Use Node lts/erbium (v12) for Netlify builds (#5925) 2020-02-06 12:03:11 -05:00
.ruby-version Update to Ruby 2.7.2 (#10594) 2020-11-05 16:11:09 +01:00
api_template.hbs Update docs with Forem instead of dev.to (#9316) 2020-07-15 13:29:11 -04:00
api_v0.yml API: Endpoint to get an organization's articles (#12237) 2021-01-13 13:09:58 +01:00
faqs.md Add first time admin login to FAQs (#11733) 2020-12-03 11:07:07 -06:00
Gemfile Upgrade Rubocop to 0.81 (#7219) 2020-04-11 10:10:04 +02:00
licensing.md Update more Forem to DEV language (#9337) 2020-07-15 18:01:34 -04:00
Makefile API: OpenAPI 3 spec and auto generated docs (#3650) 2019-08-12 11:36:04 -04:00
netlify.toml Use yarn in scripts (#12096) 2021-01-05 09:59:17 -05:00
readme.md Remove confusing line from readme (#11712) 2020-12-03 11:30:31 -06:00
self-hosting.md Update more Forem to DEV language (#9337) 2020-07-15 18:01:34 -04:00
troubleshooting.md [deploy] Remove ENVied Gem, Use dotenv Take 2 (#9767) 2020-08-14 12:20:47 -05:00

items
technical-overview
installation
getting-started
contributing
backend
frontend
admin
design
tests
faqs.md
troubleshooting.md
licensing.md
self-hosting.md
maintainers
component
Divider
creators

Welcome to Forem's developer documentation

On this site you'll find instructions to setup a local instance of Forem, documentation on the architecture of Forem, how to contribute, and many other useful documents.

This documentation site is the product of a number of volunteer contributors working alongside the Forem Core Team, special thanks to all those who have contributed to the documentation.

Running the documentation locally

Like Forem, this site is open source and the code is hosted on GitHub. If you find any incorrect information, or a even a typo, we'd love to see a pull request.

Forem's documentation is built with GitDocs NodeJS library.

To start the gitdocs server, you should run yarn gitdocs serve from the root of the forem project or from the /docs directory.

yarn gitdocs serve

This will start a server where you can browse the documentation: http://localhost:8000/

If you add new pages or rename existing pages, you'll need to restart the server for those changes to take effect.

Contributing to the docs

If you're looking for more information on contributing, check out the Contributing guide.