Nemcio/NodeBB
1
0
Fork 0
mirror of https://github.com/NodeBB/NodeBB.git synced 2025-11-14 09:55:47 +01:00
Code Issues Packages Projects Releases Wiki Activity

update all docs with new url

Browse Source
This commit is contained in:
psychobunny
2014-05-23 15:21:36 -04:00
parent dbf07f786d
commit 5f6217e831
18 changed files with 25 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/configuring/databases/mongo.rst
View File

@@ -36,7 +36,7 @@ Enter the following into the terminal, replacing `/path/to/nodebb/install/locati
.. code:: bash .. code:: bash
$ cd /path/to/nodebb/install/location $ cd /path/to/nodebb/install/location
$ git clone git://github.com/designcreateplay/NodeBB.git nodebb $ git clone git://github.com/NodeBB/NodeBB.git nodebb
Step 5: Install The Required NodeBB Dependencies Step 5: Install The Required NodeBB Dependencies
------------------------- -------------------------

2
docs/help/help.rst
View File

@@ -80,7 +80,7 @@ If successful, running the following command should show a version higher than 0
Submit Bugs on our Issue Tracker Submit Bugs on our Issue Tracker
-------------------------------- --------------------------------
Before reporting bugs, please ensure that the issue has not already been filed on our `tracker <https://github.com/designcreateplay/NodeBB/issues?state=closed>`_, or has already been resolved on our `support forum <http://community.nodebb.org/category/6/bug-reports>`_. If it has not been filed, feel free to create an account on GitHub and `create a new issue <https://github.com/designcreateplay/NodeBB/issues>`_. Before reporting bugs, please ensure that the issue has not already been filed on our `tracker <https://github.com/NodeBB/NodeBB/issues?state=closed>`_, or has already been resolved on our `support forum <http://community.nodebb.org/category/6/bug-reports>`_. If it has not been filed, feel free to create an account on GitHub and `create a new issue <https://github.com/NodeBB/NodeBB/issues>`_.
Ask the NodeBB Community Ask the NodeBB Community

4
docs/helping/index.rst
View File

@@ -7,7 +7,7 @@ NodeBB is an open source project, and will forever remain free. Here's a number
* `Follow us on Twitter <http://www.twitter.com/NodeBB>`_ and perhaps tweet **#NodeBB is most awesome forum software @NodeBB** * `Follow us on Twitter <http://www.twitter.com/NodeBB>`_ and perhaps tweet **#NodeBB is most awesome forum software @NodeBB**
* Update our wiki! ;) We need everything from development/design tutorials to user friendly how-to guides. * Update our wiki! ;) We need everything from development/design tutorials to user friendly how-to guides.
* Tell everybody about NodeBB, including your grandma and her cats. * Tell everybody about NodeBB, including your grandma and her cats.
* `Submit a pull request, or two, or three.. <http://www.github.com/designcreateplay/NodeBB>`_ * `Submit a pull request, or two, or three.. <http://www.github.com/NodeBB/NodeBB>`_
* Build a new theme * Build a new theme
* Write a plugin * Write a plugin
* Keep the link back to us on the footer of your own NodeBB :) * Keep the link back to us on the footer of your own NodeBB :)
@@ -27,7 +27,7 @@ Writing Documentation
These docs were written using `Sphinx <http://sphinx-doc.org/>`_ and published using `rtfd.org <http://readthedocs.org/>`_. These docs were written using `Sphinx <http://sphinx-doc.org/>`_ and published using `rtfd.org <http://readthedocs.org/>`_.
You can edit these docs `directly on GitHub <https://github.com/designcreateplay/NodeBB/tree/master/docs>`_, or by clicking on "View page source" on the top right of any page. You can edit these docs `directly on GitHub <https://github.com/NodeBB/NodeBB/tree/master/docs>`_, or by clicking on "View page source" on the top right of any page.
If you wish, you can clone the repository and compile the documentation yourself. Check out the `Getting Started <https://read-the-docs.readthedocs.org/en/latest/getting_started.html>`_ section for more info on how to accomplish the latter. If you wish, you can clone the repository and compile the documentation yourself. Check out the `Getting Started <https://read-the-docs.readthedocs.org/en/latest/getting_started.html>`_ section for more info on how to accomplish the latter.

2
docs/index.rst
View File

@@ -3,7 +3,7 @@
| |
**NodeBB** is a next-generation discussion platform that utilizes web sockets for instant interactions and real-time notifications. NodeBB forums have many modern features out of the box such as social network integration and streaming discussions. **NodeBB** is a next-generation discussion platform that utilizes web sockets for instant interactions and real-time notifications. NodeBB forums have many modern features out of the box such as social network integration and streaming discussions.
NodeBB is an open source project which can be forked on `GitHub <https://github.com/designcreateplay/NodeBB/>`_. Don't forget to check out the ways that you can help contribute to this project, from translations, pull requests, and telling your friends. NodeBB is an open source project which can be forked on `GitHub <https://github.com/NodeBB/NodeBB/>`_. Don't forget to check out the ways that you can help contribute to this project, from translations, pull requests, and telling your friends.
Table of Contents Table of Contents
================= =================

2
docs/installing/cloud/cloud9.rst
View File

@@ -7,7 +7,7 @@ The following are installation instructions for the `Cloud 9 <https://c9.io/>`_
.. code:: bash .. code:: bash
git clone git://github.com/designcreateplay/NodeBB.git nodebb git clone git://github.com/NodeBB/NodeBB.git nodebb
The nodebb command after the git url will create a file called nodebb so you have to CD into the file after you have cloned NodeBB. The nodebb command after the git url will create a file called nodebb so you have to CD into the file after you have cloned NodeBB.

4
docs/installing/cloud/heroku.rst
View File

@@ -6,7 +6,7 @@ Heroku
1. Download and install `Heroku Toolbelt <https://toolbelt.heroku.com/>`_ for your operating system 1. Download and install `Heroku Toolbelt <https://toolbelt.heroku.com/>`_ for your operating system
2. Log into your Heroku account: ``heroku login`` 2. Log into your Heroku account: ``heroku login``
3. Verify your Heroku account by adding a credit card (at http://heroku.com/verify) 3. Verify your Heroku account by adding a credit card (at http://heroku.com/verify)
4. Clone the repository: ``git clone https://github.com/designcreateplay/NodeBB.git /path/to/repo/clone`` 4. Clone the repository: ``git clone https://github.com/NodeBB/NodeBB.git /path/to/repo/clone``
5. ``cd /path/to/repo/clone`` 5. ``cd /path/to/repo/clone``
6. Install dependencies locally ``npm install`` 6. Install dependencies locally ``npm install``
7. Create the heroku app: ``heroku create`` 7. Create the heroku app: ``heroku create``
@@ -46,7 +46,7 @@ Heroku
16. Initialise a single dyno: ``heroku ps:scale web=1`` 16. Initialise a single dyno: ``heroku ps:scale web=1``
17. Visit your app! 17. Visit your app!
If these instructions are unclear or if you run into trouble, please let us know by `filing an issue <https://github.com/designcreateplay/NodeBB/issues>`_. If these instructions are unclear or if you run into trouble, please let us know by `filing an issue <https://github.com/NodeBB/NodeBB/issues>`_.
Keeping it up to date Keeping it up to date
--------------------- ---------------------

2
docs/installing/cloud9.rst
View File

@@ -7,7 +7,7 @@ The following are installation instructions for the `Cloud 9 <https://c9.io/>`_
.. code:: bash .. code:: bash
git clone git://github.com/designcreateplay/NodeBB.git nodebb git clone git://github.com/NodeBB/NodeBB.git nodebb
The nodebb command after the git url will create a file called nodebb so you have to CD into the file after you have cloned NodeBB. The nodebb command after the git url will create a file called nodebb so you have to CD into the file after you have cloned NodeBB.

4
docs/installing/heroku.rst
View File

@@ -6,7 +6,7 @@ Heroku
1. Download and install `Heroku Toolbelt <https://toolbelt.heroku.com/>`_ for your operating system 1. Download and install `Heroku Toolbelt <https://toolbelt.heroku.com/>`_ for your operating system
2. Log into your Heroku account: ``heroku login`` 2. Log into your Heroku account: ``heroku login``
3. Verify your Heroku account by adding a credit card (at http://heroku.com/verify) 3. Verify your Heroku account by adding a credit card (at http://heroku.com/verify)
4. Clone the repository: ``git clone https://github.com/designcreateplay/NodeBB.git /path/to/repo/clone`` 4. Clone the repository: ``git clone https://github.com/NodeBB/NodeBB.git /path/to/repo/clone``
5. ``cd /path/to/repo/clone`` 5. ``cd /path/to/repo/clone``
6. Install dependencies locally ``npm install`` 6. Install dependencies locally ``npm install``
7. Create the heroku app: ``heroku create`` 7. Create the heroku app: ``heroku create``
@@ -32,7 +32,7 @@ Heroku
14. Initialise a single dyno: ``heroku ps:scale web=1`` 14. Initialise a single dyno: ``heroku ps:scale web=1``
15. Visit your app! 15. Visit your app!
If these instructions are unclear or if you run into trouble, please let us know by `filing an issue <https://github.com/designcreateplay/NodeBB/issues>`_. If these instructions are unclear or if you run into trouble, please let us know by `filing an issue <https://github.com/NodeBB/NodeBB/issues>`_.
Keeping it up to date Keeping it up to date
--------------------- ---------------------

4
docs/installing/os/debian.rst
View File

@@ -139,7 +139,7 @@ Next clone this repository :
.. code:: bash .. code:: bash
$ cd /path/to/nodebb/install/location $ cd /path/to/nodebb/install/location
$ git clone git://github.com/designcreateplay/NodeBB.git nodebb $ git clone git://github.com/NodeBB/NodeBB.git nodebb
Now we are going to install all dependencies for NodeBB via NPM : Now we are going to install all dependencies for NodeBB via NPM :
@@ -172,6 +172,6 @@ And after all.. let's run the NodeBB forum
Extras, tips and Advice Extras, tips and Advice
^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^
You should secure your NodeBB installation, `take a look here <https://github.com/designcreateplay/NodeBB#securing-nodebb>`_. You should secure your NodeBB installation, `take a look here <https://github.com/NodeBB/NodeBB#securing-nodebb>`_.
You should use Nginx (or similar) in order to reverse proxy your NodeBB installation on the port 80, :doc:`take a look here <../../configuring/proxies>` You should use Nginx (or similar) in order to reverse proxy your NodeBB installation on the port 80, :doc:`take a look here <../../configuring/proxies>`

4
docs/installing/os/smartos.rst
View File

@@ -86,7 +86,7 @@ Installation
.. code:: bash .. code:: bash
$ git clone git://github.com/designcreateplay/NodeBB.git nodebb $ git clone git://github.com/NodeBB/NodeBB.git nodebb
5. Install NodeBB's npm dependencies: 5. Install NodeBB's npm dependencies:
@@ -125,7 +125,7 @@ Installation
**Note:** With port 80 the `:80` does not need to be entered. **Note:** With port 80 the `:80` does not need to be entered.
**Note:** If these instructions are unclear or if you run into trouble, please let us know by `filing an issue <https://github.com/designcreateplay/NodeBB/issues>`_. **Note:** If these instructions are unclear or if you run into trouble, please let us know by `filing an issue <https://github.com/NodeBB/NodeBB/issues>`_.
Upgrading NodeBB Upgrading NodeBB
---------------- ----------------

2
docs/installing/os/ubuntu.rst
View File

@@ -26,7 +26,7 @@ Next, clone this repository:
.. code:: bash .. code:: bash
$ cd /path/to/nodebb/install/location $ cd /path/to/nodebb/install/location
$ git clone git://github.com/designcreateplay/NodeBB.git nodebb $ git clone git://github.com/NodeBB/NodeBB.git nodebb
Obtain all of the dependencies required by NodeBB: Obtain all of the dependencies required by NodeBB:

2
docs/installing/os/windows8.rst
View File

@@ -27,7 +27,7 @@ Open Git Shell, and type the following commands. Clone NodeBB repo:
.. code:: bash .. code:: bash
git clone https://github.com/designcreateplay/NodeBB.git git clone https://github.com/NodeBB/NodeBB.git
Enter directory: Enter directory:

2
docs/plugins/create.rst
View File

@@ -16,7 +16,7 @@ There are two types of hooks: **filters** and **actions**.
**Actions** are executed at certain points of NodeBB, and are useful if you'd like to *do* something after a certain trigger. For example, an action hook can be used to notify an admin if a certain user has posted. Other uses include analytics recording, or automatic welcome posts on new user registration. **Actions** are executed at certain points of NodeBB, and are useful if you'd like to *do* something after a certain trigger. For example, an action hook can be used to notify an admin if a certain user has posted. Other uses include analytics recording, or automatic welcome posts on new user registration.
When you are writing your plugin, make sure a hook exists where you'd like something to happen. If a hook isn't present, `file an issue <https://github.com/designcreateplay/NodeBB/issues>`_ and we'll include it in the next version of NodeBB. When you are writing your plugin, make sure a hook exists where you'd like something to happen. If a hook isn't present, `file an issue <https://github.com/NodeBB/NodeBB/issues>`_ and we'll include it in the next version of NodeBB.
Configuration Configuration
------------------ ------------------

2
docs/plugins/hooks.rst
View File

@@ -5,7 +5,7 @@ The following is a list of all hooks present in NodeBB. This list is intended to
There are two types of hooks, **filters**, and **actions**. Filters take an input (provided as a single argument), parse it in some way, and return the changed value. Actions take multiple inputs, and execute actions based on the inputs received. Actions do not return anything. There are two types of hooks, **filters**, and **actions**. Filters take an input (provided as a single argument), parse it in some way, and return the changed value. Actions take multiple inputs, and execute actions based on the inputs received. Actions do not return anything.
**Important**: This list is by no means exhaustive. Hooks are added on an as-needed basis (or if we can see a potential use case ahead of time), and all requests to add new hooks to NodeBB should be sent to us via the `issue tracker <https://github.com/designcreateplay/NodeBB/issues>`_. **Important**: This list is by no means exhaustive. Hooks are added on an as-needed basis (or if we can see a potential use case ahead of time), and all requests to add new hooks to NodeBB should be sent to us via the `issue tracker <https://github.com/NodeBB/NodeBB/issues>`_.
Filters Filters

4
docs/plugins/settings.rst
View File

@@ -299,8 +299,8 @@ All methods get called within Settings-scope.
``trim`` Whether the value is assumed as trimmed. ``trim`` Whether the value is assumed as trimmed.
For further impression take a look at the For further impression take a look at the
`default plugins <https://github.com/designcreateplay/NodeBB/tree/master/public/src/modules/settings>`_. `default plugins <https://github.com/NodeBB/NodeBB/tree/master/public/src/modules/settings>`_.
You should also take a look at the helper-functions within You should also take a look at the helper-functions within
`Settings <https://github.com/designcreateplay/NodeBB/tree/master/public/src/modules/settings.js>`_ in order to create `Settings <https://github.com/NodeBB/NodeBB/tree/master/public/src/modules/settings.js>`_ in order to create
your own plugins. There are a few methods that take response to call the methods of other plugins when fittingly. your own plugins. There are a few methods that take response to call the methods of other plugins when fittingly.

2
docs/resources.rst
View File

@@ -10,7 +10,7 @@ Developer's Resources
Core Core
---- ----
* `Building a new Admin Page <https://github.com/designcreateplay/NodeBB/wiki/How-to-build-a-new-Admin-Page>`_ (Out of date) * `Building a new Admin Page <https://github.com/NodeBB/NodeBB/wiki/How-to-build-a-new-Admin-Page>`_ (Out of date)
Plugins Plugins

4
docs/upgrading/index.rst
View File

@@ -1,7 +1,7 @@
Upgrading NodeBB Upgrading NodeBB
====================== ======================
NodeBB's periodic releases are located in the `Releases <https://github.com/designcreateplay/NodeBB/releases>`_. These releases contain what is usually considered the most bug-free code, and is designed to be used on production-level instances of NodeBB. NodeBB's periodic releases are located in the `Releases <https://github.com/NodeBB/NodeBB/releases>`_. These releases contain what is usually considered the most bug-free code, and is designed to be used on production-level instances of NodeBB.
You can utilise git to install a specific version of NodeBB, and upgrade periodically as new releases are made. You can utilise git to install a specific version of NodeBB, and upgrade periodically as new releases are made.
@@ -124,7 +124,7 @@ If not upgrading between branches, just run the following command:
This should retrieve the latest (and greatest) version of NodeBB from the repository. This should retrieve the latest (and greatest) version of NodeBB from the repository.
Alternatively, download and extract the latest versioned copy of the code from `the Releases Page <https://github.com/designcreateplay/NodeBB/releases>`_. Overwrite any files as necessary. This method is not supported. Alternatively, download and extract the latest versioned copy of the code from `the Releases Page <https://github.com/NodeBB/NodeBB/releases>`_. Overwrite any files as necessary. This method is not supported.
4. Run the NodeBB upgrade script 4. Run the NodeBB upgrade script
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

2
docs/widgets/create.rst
View File

@@ -74,5 +74,5 @@ Pass this back in the array:
} }
And that's all. You can define as many Widget Areas in your theme as you wish. If you're still stuck, have a look at `this commit <https://github.com/designcreateplay/nodebb-theme-cerulean/commit/50e49a9da5a89484fa8001bbda2e613b69f18e86>`_ which upgraded the Cerulean theme to use the widget system. And that's all. You can define as many Widget Areas in your theme as you wish. If you're still stuck, have a look at `this commit <https://github.com/NodeBB/nodebb-theme-cerulean/commit/50e49a9da5a89484fa8001bbda2e613b69f18e86>`_ which upgraded the Cerulean theme to use the widget system.