From 5f6217e831519cafe7e02a3e4fa07daf91c18f03 Mon Sep 17 00:00:00 2001 From: psychobunny Date: Fri, 23 May 2014 15:21:36 -0400 Subject: [PATCH] update all docs with new url --- docs/configuring/databases/mongo.rst | 2 +- docs/help/help.rst | 2 +- docs/helping/index.rst | 4 ++-- docs/index.rst | 2 +- docs/installing/cloud/cloud9.rst | 2 +- docs/installing/cloud/heroku.rst | 4 ++-- docs/installing/cloud9.rst | 2 +- docs/installing/heroku.rst | 4 ++-- docs/installing/os/debian.rst | 4 ++-- docs/installing/os/smartos.rst | 4 ++-- docs/installing/os/ubuntu.rst | 2 +- docs/installing/os/windows8.rst | 2 +- docs/plugins/create.rst | 2 +- docs/plugins/hooks.rst | 2 +- docs/plugins/settings.rst | 4 ++-- docs/resources.rst | 2 +- docs/upgrading/index.rst | 4 ++-- docs/widgets/create.rst | 2 +- 18 files changed, 25 insertions(+), 25 deletions(-) diff --git a/docs/configuring/databases/mongo.rst b/docs/configuring/databases/mongo.rst index 922eee9c59..64955a9133 100644 --- a/docs/configuring/databases/mongo.rst +++ b/docs/configuring/databases/mongo.rst @@ -36,7 +36,7 @@ Enter the following into the terminal, replacing `/path/to/nodebb/install/locati .. code:: bash $ 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 ------------------------- diff --git a/docs/help/help.rst b/docs/help/help.rst index 5bb75b5af9..f951c9df55 100644 --- a/docs/help/help.rst +++ b/docs/help/help.rst @@ -80,7 +80,7 @@ If successful, running the following command should show a version higher than 0 Submit Bugs on our Issue Tracker -------------------------------- -Before reporting bugs, please ensure that the issue has not already been filed on our `tracker `_, or has already been resolved on our `support forum `_. If it has not been filed, feel free to create an account on GitHub and `create a new issue `_. +Before reporting bugs, please ensure that the issue has not already been filed on our `tracker `_, or has already been resolved on our `support forum `_. If it has not been filed, feel free to create an account on GitHub and `create a new issue `_. Ask the NodeBB Community diff --git a/docs/helping/index.rst b/docs/helping/index.rst index d76ca54da4..de31b48803 100644 --- a/docs/helping/index.rst +++ b/docs/helping/index.rst @@ -7,7 +7,7 @@ NodeBB is an open source project, and will forever remain free. Here's a number * `Follow us on Twitter `_ 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. * Tell everybody about NodeBB, including your grandma and her cats. -* `Submit a pull request, or two, or three.. `_ +* `Submit a pull request, or two, or three.. `_ * Build a new theme * Write a plugin * 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 `_ and published using `rtfd.org `_. -You can edit these docs `directly on GitHub `_, or by clicking on "View page source" on the top right of any page. +You can edit these docs `directly on GitHub `_, 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 `_ section for more info on how to accomplish the latter. diff --git a/docs/index.rst b/docs/index.rst index c086e5b737..7ec6a0561f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -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 an open source project which can be forked on `GitHub `_. 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 `_. 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 ================= diff --git a/docs/installing/cloud/cloud9.rst b/docs/installing/cloud/cloud9.rst index 0e5d2e0594..8a857335ea 100644 --- a/docs/installing/cloud/cloud9.rst +++ b/docs/installing/cloud/cloud9.rst @@ -7,7 +7,7 @@ The following are installation instructions for the `Cloud 9 `_ .. 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. diff --git a/docs/installing/cloud/heroku.rst b/docs/installing/cloud/heroku.rst index e6aaa6f27a..a5e6c22dbe 100644 --- a/docs/installing/cloud/heroku.rst +++ b/docs/installing/cloud/heroku.rst @@ -6,7 +6,7 @@ Heroku 1. Download and install `Heroku Toolbelt `_ for your operating system 2. Log into your Heroku account: ``heroku login`` 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`` 6. Install dependencies locally ``npm install`` 7. Create the heroku app: ``heroku create`` @@ -46,7 +46,7 @@ Heroku 16. Initialise a single dyno: ``heroku ps:scale web=1`` 17. Visit your app! -If these instructions are unclear or if you run into trouble, please let us know by `filing an issue `_. +If these instructions are unclear or if you run into trouble, please let us know by `filing an issue `_. Keeping it up to date --------------------- diff --git a/docs/installing/cloud9.rst b/docs/installing/cloud9.rst index 0e5d2e0594..8a857335ea 100644 --- a/docs/installing/cloud9.rst +++ b/docs/installing/cloud9.rst @@ -7,7 +7,7 @@ The following are installation instructions for the `Cloud 9 `_ .. 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. diff --git a/docs/installing/heroku.rst b/docs/installing/heroku.rst index 23ad0f0ee3..f484531e3f 100644 --- a/docs/installing/heroku.rst +++ b/docs/installing/heroku.rst @@ -6,7 +6,7 @@ Heroku 1. Download and install `Heroku Toolbelt `_ for your operating system 2. Log into your Heroku account: ``heroku login`` 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`` 6. Install dependencies locally ``npm install`` 7. Create the heroku app: ``heroku create`` @@ -32,7 +32,7 @@ Heroku 14. Initialise a single dyno: ``heroku ps:scale web=1`` 15. Visit your app! -If these instructions are unclear or if you run into trouble, please let us know by `filing an issue `_. +If these instructions are unclear or if you run into trouble, please let us know by `filing an issue `_. Keeping it up to date --------------------- diff --git a/docs/installing/os/debian.rst b/docs/installing/os/debian.rst index b1df1d5db1..8c59d7f0f9 100644 --- a/docs/installing/os/debian.rst +++ b/docs/installing/os/debian.rst @@ -139,7 +139,7 @@ Next clone this repository : .. code:: bash $ 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 : @@ -172,6 +172,6 @@ And after all.. let's run the NodeBB forum Extras, tips and Advice ^^^^^^^^^^^^^^^^^^^^^^^ -You should secure your NodeBB installation, `take a look here `_. +You should secure your NodeBB installation, `take a look here `_. 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>` \ No newline at end of file diff --git a/docs/installing/os/smartos.rst b/docs/installing/os/smartos.rst index cbc194c9c1..c28f4d8457 100644 --- a/docs/installing/os/smartos.rst +++ b/docs/installing/os/smartos.rst @@ -86,7 +86,7 @@ Installation .. 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: @@ -125,7 +125,7 @@ Installation **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 `_. +**Note:** If these instructions are unclear or if you run into trouble, please let us know by `filing an issue `_. Upgrading NodeBB ---------------- diff --git a/docs/installing/os/ubuntu.rst b/docs/installing/os/ubuntu.rst index f1a663e0b7..2efd3963ac 100644 --- a/docs/installing/os/ubuntu.rst +++ b/docs/installing/os/ubuntu.rst @@ -26,7 +26,7 @@ Next, clone this repository: .. code:: bash $ 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: diff --git a/docs/installing/os/windows8.rst b/docs/installing/os/windows8.rst index cfb0d41c7a..274254f45a 100644 --- a/docs/installing/os/windows8.rst +++ b/docs/installing/os/windows8.rst @@ -27,7 +27,7 @@ Open Git Shell, and type the following commands. Clone NodeBB repo: .. code:: bash - git clone https://github.com/designcreateplay/NodeBB.git + git clone https://github.com/NodeBB/NodeBB.git Enter directory: diff --git a/docs/plugins/create.rst b/docs/plugins/create.rst index 568c9ece8d..5f5193b8f8 100644 --- a/docs/plugins/create.rst +++ b/docs/plugins/create.rst @@ -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. -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 `_ 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 `_ and we'll include it in the next version of NodeBB. Configuration ------------------ diff --git a/docs/plugins/hooks.rst b/docs/plugins/hooks.rst index 4540cdc822..c8e5267358 100644 --- a/docs/plugins/hooks.rst +++ b/docs/plugins/hooks.rst @@ -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. -**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 `_. +**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 `_. Filters diff --git a/docs/plugins/settings.rst b/docs/plugins/settings.rst index 7ab7febb53..94e32da115 100644 --- a/docs/plugins/settings.rst +++ b/docs/plugins/settings.rst @@ -299,8 +299,8 @@ All methods get called within Settings-scope. ``trim`` Whether the value is assumed as trimmed. For further impression take a look at the -`default plugins `_. +`default plugins `_. You should also take a look at the helper-functions within -`Settings `_ in order to create +`Settings `_ in order to create your own plugins. There are a few methods that take response to call the methods of other plugins when fittingly. diff --git a/docs/resources.rst b/docs/resources.rst index ae0f398dfc..47984ad9da 100644 --- a/docs/resources.rst +++ b/docs/resources.rst @@ -10,7 +10,7 @@ Developer's Resources Core ---- -* `Building a new Admin Page `_ (Out of date) +* `Building a new Admin Page `_ (Out of date) Plugins diff --git a/docs/upgrading/index.rst b/docs/upgrading/index.rst index be5ce29edf..12c1b3d1e0 100644 --- a/docs/upgrading/index.rst +++ b/docs/upgrading/index.rst @@ -1,7 +1,7 @@ Upgrading NodeBB ====================== -NodeBB's periodic releases are located in the `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 `_. 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. @@ -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. -Alternatively, download and extract the latest versioned copy of the code from `the Releases Page `_. 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 `_. Overwrite any files as necessary. This method is not supported. 4. Run the NodeBB upgrade script ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/widgets/create.rst b/docs/widgets/create.rst index b3f0041bc3..e3c11f1039 100644 --- a/docs/widgets/create.rst +++ b/docs/widgets/create.rst @@ -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 `_ 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 `_ which upgraded the Cerulean theme to use the widget system.