docbrown/docs
Sarthak Sharma 6dee5edd0e
🚀 Ability to allow tag moderators to create chat channels (#9741)
* Feature 🚀 : Ability to delete messages in chat channels

- Sending message ID to frontend
- Deleting Message
- Use pusher to delete message realtime

* Minor Bug 🐞: Show message action only for current user

- User can delete or edit their own messages

* Test cases added

* Bug 🐞: Update message id for receiver

Message id was not sent to receiver by pusher

* Refactoring🛠: Message controller refactoring

* Test Cases📝 : Specs for Delete message added

* Feature 🚀 : Ability to edit messages

* Test Cases📝 : Specs for Edit message added

* Merge conflict resolved

* UI completed for Create Channel

* API for create channel & invitations

* 🚀 Combining Backend and Frontend

* Test cases added

* UI completed for Create Channel

* API for create channel & invitations

* 🚀 Combining Backend and Frontend

* Test cases added

* fix suggestions

* add test cases

* replace mod_relations_admin to tag_moderator

* fix test cases

* refactor and fix code climate issues

* Update app/controllers/chat_channel_memberships_controller.rb

Co-authored-by: Michael Kohl <me@citizen428.net>

* fix suggestions

* renaming the methods

* Update app/javascript/chat/chat.jsx

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

* Update app/javascript/chat/components/createChatModal.jsx

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

* add jsDoc and add validation

* add PR suggestions

* renmae the file name to  PascalCase

* add styled component

* refactor channel button component

* fix specs

* fix code smell issues

* fix file name issue

* handle error message

* add jsDoc

* Update app/controllers/chat_channels_controller.rb

Co-authored-by: Michael Kohl <me@citizen428.net>

* refactor chat_channel_helpers

* update old hash to new hash

* Update app/javascript/chat/components/ChannelButton.jsx

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

* Update app/views/chat_channels/index.html.erb

Co-authored-by: Michael Kohl <me@citizen428.net>

* fix syntax error

* Update app/views/chat_channels/index.html.erb

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

* Policies changed

* The Disable Button issue 🐞

* Fixing Disabled button Issue 🐞

* New group doesn't show up 🐞

Co-authored-by: Narender Singh <narender2031@gmail.com>
Co-authored-by: Michael Kohl <me@citizen428.net>
Co-authored-by: Nick Taylor <nick@iamdeveloper.com>
2020-12-08 13:10:36 +07: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 Storybook: Add DocsPage and test out static content (#11397) 2020-12-02 09:56:38 -08: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 🚀 Ability to allow tag moderators to create chat channels (#9741) 2020-12-08 13:10:36 +07:00
getting-started Add first time admin login to FAQs (#11733) 2020-12-03 11:07:07 -06: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 Remove concept of "ongoing" field tests and clarify a/b test instructions/expectations. (#11734) 2020-12-07 13:52:54 -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 Add configs/show api for admins (#11358) 2020-12-01 12:22:07 -05: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 Fix Netlify catch all redirections (#9717) 2020-08-10 13:37:15 -04: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.