nodebb / docs

NodeBB Documentation via MkDocs

NodeBB Documentation Portal

This repository houses the content and source code for the documentation portal.

Contributing

The primary method of contributing is by making a pull request. You can either edit the source code directly in GitHub (which would automatically fork the repository into your own account), or by cloning a local copy and forking the repository manually.

Documentation is written in Markdown. While Markdown supports HTML, we encourage the minimal use of HTML so as to ensure that all documentation is of similar style.

If there are insufficient articles or incorrect information, please file a new issue against this repository. It will help us ensure that content is kept up to date.

When changes are committed or pull requests merged, the documentation portal will be updated automatically. If this is not the case, please open an issue for us to investigate.

How to test your changes

If you want to take a look at how your changes look, you can run a local install of the documentation portal.

1. Install pip: sudo apt-get update && sudo apt-get install python3-pip
2. Install mkdocs: pip3 install mkdocs (you may need sudo for this, Windows users may need to run python -m pip install mkdocs instead)
3. Install the material theme: pip3 install mkdocs-material
4. From repo root, create a symbolic link pointing to src/docs: ln -s ./src/docs
5. Install dependencies: yarn or npm
6. Build templates: node src/compile.js
7. Start development mode: mkdocs serve (run this from the root of the checked out repository, python -m mkdocs serve for Windows)
8. Browse to http://localhost:8000

The page will automatically refresh every time any files are changed.

Localisation

At this time we do not have plans to localise the NodeBB documentation.

docs's Issues

Add a warning regarding nginx proxy_pass

Hi !
In the nginx config documentation, the proxy_pass redirect to http://127.0.0.1:4567;
By setting a "/" at the end of that url, url are decoded (https://serverfault.com/questions/459369/disabling-url-decoding-in-nginx-proxy#comment610623_463932) and hence vulnerable to XSS (NodeBB/NodeBB#4192).
It's fairly easy to make the mistake of putting an ending slash (and the proxy still work), so that a warning in the doc would be welcome.
Apart from ours instances, I've spotted a couple of websites having the same issue :)

documentation refrences 1.5.x

just curious why the documentation docs says 1.5.x and not just pull from master or the latest version 1.6.1.

Issues as newbie to NodeBB project

Hi, I am a newbie to the project. I faced a few issues while installing the nodeBB app and the docs app.

NodeBB app

• Installation doesn't mention instructions to install MongoDB, only redis. The part on installing mongdb comes in the configuring part while it is needed before running the setup script.
• In the via the cloud section in Installation, there is a none section and clicking on it opens a page with 404 - Not found message.

Docs

• Installation instructions are only for linux
• The source code has instructions for two MacOS versions it seems, but it shows only one - Maverick and Big Sur.
• The file structure has yarn.lock but not package-lock.json. While installing, git shows package-lock.json also. Should we include it or update gitignore?

Will be happy to open PR for these :)

System requirements >512MB RAM

[Feature] Adding Elestio as Deployment option

Hey team,
I am Kaiwalya, Developer Advocate at Elestio. Elestio has been providing options of fully deploying and managing NodeBB application as shown here. I think it would be a great idea if we can add it to official readme/documentation here.
In addition to this, if you are interested we provide collaboration opportunities with tools we support by revenue share upon addition of this method in docs. If you would like to collaborate, just drop me an email at [email protected] :)

requirejs Removed

in https://docs.nodebb.org/development/plugins/libraries/
(https://github.com/NodeBB/docs/blob/master/src/docs/development/plugins/libraries.md):

From your client-side scripts, you can then load the jQuery module via require.js as follows:

require(['jquery'], function ($) {
   $('.someClass').addClass('someotherclass');
});

This is while requirejs has been deprecated by NodeBB 2.0...

No documentation of subfolder configuration

There's a brief comment about setting the subfolder in config.json, but not in any of the reverse proxy documentation.

How to help Docs i18n?

I find NodeBB Docs use Mkdocs instead of readthedocs now . But I can't find where to translate this docs.

---

Is it possible to add a localized third-party document link to an official document? I have created a Chinese Documents(Is not a complete official document translation) via kancloud.cn

Recommend upgrading node.js on the upgrade page

curl -sL https://deb.nodesource.com/setup_14.x | sudo -E bash -
sudo apt-get install -y nodejs

As an example

Development -> Plugins -> `plugin.json` needs updating

• The sample config at the top of the file does not contain a modules section
• The link to "Third-Party Libraries" is incorrect
• The modules section needs to be expanded
• The acpScripts section needs to be deprecated
• Revision to mention webpack

Build system for automatic updates

Keep things like versions up to date with latest

Navbar resizing Issue when using browser arrows for naivgation.

Hello im having issue with the navbar covering part of my page when using the browser arrows to go back. Im not sure where in the source code the pagination section gets added to the navbar but i would like to just add it to the body for a temporary solution.
home page

click into sub category

clicked back but navbar did not resize

Add gitpod install(cloud)

Nodebb can run in gitpod.
You can discover it because I have not tried.
https://gitpod.io

Feature request: show link to edit the source of docs

Consider add the link to github.com/NodeBB/docs repo onto the template of https://docs.nodebb.org.

Even better if they can relatively link to individual source file so people can quickly suggest fixes.

ubuntu install file is non-existent in github?

I'm trying to edit the broken link to Configuring Databases on the ubuntu install page. But the link to edit the page leads to https://github.com/NodeBB/docs/edit/master/src/docs/installing/os/ubuntu.md which does not exist. Can't find where the source is of the ubuntu docs.

Error in document

Here: https://docs.nodebb.org/installing/cloud/heroku/ You can use heroku's free database while it closes - https://devcenter.heroku.com/changelog-items/1823

Mongodb systemd problems

I wanna know from you guys how to improve the docs. I'm following the instructions to run mongodb, when I try to start the mongod service, I get an error:
vagrant@vagrant-ubuntu-trusty-64:~$ sudo systemctl start mongod
sudo: systemctl: command not found

I have to install systemd to solve this
$ sudo apt-get install systemd

After do this I was able to run the commands:
$ sudo service mongod start
$ sudo service mongod status

Missing explanation of plugins:active in config.json

This feature was added with NodeBB/NodeBB#10767

Debain docs outdated / Merge with Ubuntu?

The Debian installation page is very outdated, since it mentions Wheezy, Node 0.12, etc.

I was going to update it but the Ubuntu page will basically work exactly the same, besides 2 or 3 repositories that are also available on Debian.

I have 2 propositions:

• To rewrite the Debian page from the Ubuntu page (= paste the Ubuntu page and make a few changes)
• To merge both pages and point out differences. (This might not even be needed if we use lsb_release for the repositories URL, for instance).

What do you think? Both should be pretty quick and easy to do.

Remove $ from commands in Ubuntu docs.

The $ symbol is copied along with the command which makes the copy buttons useless. The $ symbol can be removed