473c2ccb8d
* Removing ElasticSearch Brew instructions If you try to install brew as directed you get this Error: Error: Calling Installation of elasticsearch-oss from a GitHub commit URL is disabled! Use 'brew extract elasticsearch-oss' to stable tap on GitHub instead. Brew/ElasticSearch no longer allows you to tap as we previously have suggested in the doc. Also we can no longer grab the 7.5.2 version with brew. We have decided to remove the instructions for now until we upgrade ElasticSearch if possible. * Adding recommended changes. Added back line 15 per Nicks recommendation (i.e. with rbenv: `rbenv install $(cat .ruby-version)`) Line 65 updated to 7.5 or higher for Elasticsearch per Rhymes recommendation ~Forem requires a version of Elasticsearch 7.5 or higher to be running. We recommend version 7.5.2.~ Line 110 update: Added back in the Homebrew instructions but updated commands to `install elastic/tap/elasticsearch-oss` * Updating wording per Molly's suggestion Updating "to be running " to "run" and adjusting line 64 to "Forem requires Elasticsearch 7.x to run. We recommend version 7.5.2." |
||
|---|---|---|
| .. | ||
| .static | ||
| admin | ||
| backend | ||
| contributing | ||
| creators | ||
| design | ||
| frontend | ||
| getting-started | ||
| installation | ||
| maintainers | ||
| technical-overview | ||
| tests | ||
| .gitdocs.json | ||
| .nvmrc | ||
| .ruby-version | ||
| api_template.hbs | ||
| api_v0.yml | ||
| faqs.md | ||
| Gemfile | ||
| licensing.md | ||
| Makefile | ||
| netlify.toml | ||
| readme.md | ||
| self-hosting.md | ||
| troubleshooting.md | ||
| items | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
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. Follow these steps to get the documentation site running locally.
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.