Skip to content

Commit

Permalink
Corrected a number of inbound links pointing to the documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
Sam Minnee committed Oct 9, 2012
1 parent c28dd4c commit c4d2f9e
Show file tree
Hide file tree
Showing 6 changed files with 11 additions and 13 deletions.
4 changes: 2 additions & 2 deletions docs/en/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
This website documents high-level features of the [SilverStripe open source platform](http://www.silverstripe.org), aimed
at developers.
Please read our [guide to contributing documentation](misc/contributing#writing-documentation) if you want to help out!
Please read our [guide to contributing documentation](misc/contributing/documentation) if you want to help out!

### Overview

Expand Down Expand Up @@ -54,7 +54,7 @@ Please read our [guide to contributing documentation](misc/contributing#writing-

### Level 4: Contributing to the SilverStripe core

* [Contributing](http://www.silverstripe.org/contributing-to-silverstripe/)
* [Contributing](misc/contributing)
* [Coding Conventions](misc/coding-conventions)

<div class="hint" markdown="1">
Expand Down
4 changes: 1 addition & 3 deletions docs/en/misc/contributing/code.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ which creates a copy that you can commit to (see github's [guide to "forking"](h
For other modules, our [module list on silverstripe.org](http://silverstripe.org/modules) lists the repository locations, typically using a version control system like "git" or "[subversion](subversion)".

<div class="hint" markdown="1">
Note: By supplying code to the SilverStripe core team in patches, tickets and pull requests, you agree to assign copyright of that change to SilverStripe Limited, on the condition that SilverStripe Limited releases that code under the BSD license.
Note: By supplying code to the SilverStripe core team in patches, tickets and pull requests, you agree to assign copyright of that code to SilverStripe Limited, on the condition that SilverStripe Limited releases that code under the BSD license.

We ask for this so that the ownership in the license is clear and unambiguous, and so that community involvement doesn't stop us from being able to continue supporting these projects. By releasing this code under a permissive license, this copyright assignment won't prevent you from using the code in any way you see fit.
</div>
Expand Down Expand Up @@ -151,8 +151,6 @@ Then, you can push your new branch to GitHub, like this (replace `100-dataobject

You should be able to log into your GitHub account, switch to the branch, and see that your changes have been committed. Then click the Pull button to request that your commits get merged into the development master.

*IMPORTANT*: Before you issue a pull request, make sure it gets accepted by running through the ["Contributing Check List"](contributing#check-list).

### Rebase Your Development Branch on the Latest Upstream

To keep your development branch up to date, rebase your changes on top of the current state of the upstream master. See the [What is git rebase?](code#what-is-git-rebase) section below to learn more about rebasing.
Expand Down
4 changes: 2 additions & 2 deletions docs/en/misc/contributing/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ In order to balance editorial control with effective collaboration, we keep
documentation alongside the module source code, e.g. in `framework/docs/`,
or as code comments within PHP code.
Contributing documentation is the same process as providing any other patch
(see [Patches and Bugfixes](contributing#submitting-patches-bugfixes-and-enhancements)).
(see [Contributing code](code)).

## What to write

Expand Down Expand Up @@ -144,7 +144,7 @@ on placing HTML blocks inside Markdown.
Documentation is kept alongside the source code, typically in a module subdirectory like `framework/docs/en/`.
Each language has its own subfolder, which can duplicate parts or the whole body of documentation.
German documentation would for example live in `framework/docs/de/`.
The [sapphiredocs](https://github.com/silverstripe/silverstripe-sapphiredocs) module that drives
The [docsviewer](https://github.com/silverstripe/silverstripe-docsviewer) module that drives
[doc.silverstripe.org](http://doc.silverstripe.org) automatically resolves these subfolders into a language dropdown.

## Further reading
Expand Down
8 changes: 4 additions & 4 deletions docs/en/misc/module-release-process.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ available for opensource projects, including wiki and bugtracker functionality
your modules page on silverstripe.org
* Be involved in our community
* Subscripe to our developer mailing list and be available to answer questions on the forum.
* Attend [irc:our weekly core discussions on IRC](irc/our weekly core discussions on IRC) as regularly as you can.
* Attend our weekly core discussions on IRC as regularly as you can.
* Create an **issue tracker** so your users can file bugs and feature requests (see ["Feedback and Bugtracking"](module-release-process#feedback-and-bugtracking) below)
* Create a **roadmap** and **milestones** outlining future release planning

Expand All @@ -64,7 +64,7 @@ release candidate. If your release candidate is found to be stable, then you ca

You should have both **developer documentation** and **user documentation**, and keep them updated with your releases.
See [Producing OSS: "Documentation"](http://producingoss.com/en/getting-started.html#documentation) and our
[contributing guide](contributing#writing-documentation).
[contributing guide](contributing/documentation).

### README file

Expand Down Expand Up @@ -236,7 +236,7 @@ trunk.
## See Also

* [Module Development](/topics/module-development)
* [Documentation Guide](contributing#writing-documentation)
* [Contributing to SilverStripe](http://silverstripe.org/contributing-to-silverstripe/)
* [Documentation Guide](contributing/documentation)
* [Contributing to SilverStripe](contributing)
* [Submit your Module](http://silverstripe.org/modules/manage/add)
* [subversion](subversion)
2 changes: 1 addition & 1 deletion docs/en/misc/ss-markdown.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,4 +112,4 @@ Of course, the `sapphiredocs` code is BSD licensed - we're looking forward to yo

## Related ##

* [contributing](contributing#writing-documentation): The doc.silverstripe.org website has certain styling and writing conventions
* [contributing/documentation](contributing/documentation): The doc.silverstripe.org website has certain styling and writing conventions
2 changes: 1 addition & 1 deletion docs/en/topics/directory-structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Example Forum:

Module developers can bundle developer documentation with their code by producing
plain text files inside a 'docs' folder located in the module folder. These files
can be written with the Markdown syntax (See ["Writing Documentation"](/misc/contributing#writing-documentation))
can be written with the Markdown syntax (See [Contributing Documentation](/misc/contributing/documentation))
and include media such as images or videos.

Inside the docs folder, developers should organize the markdown files into each
Expand Down

0 comments on commit c4d2f9e

Please sign in to comment.