Skip to content
Browse files

Removes text references (again??) to bluehawk's forks. Refs #3782

  • Loading branch information...
1 parent 6e5c740 commit b795e0f885b6a0acbd091237064e0c8447fdb1f1 @kiall kiall committed
Showing with 23 additions and 80 deletions.
  1. +0 −49 README.md
  2. +23 −31 guide/userguide/contributing.md
View
49 README.md
@@ -30,55 +30,6 @@ Any images used in the userguide pages must be in `media/guide/<module>/`. For
The API browser is generated from the actual source code. The descriptions for classes, constants, properties, and methods is extracted from the comments and parsed in Markdown. For example if you look in the comment for [Kohana_Core::init](http://github.com/kohana/core/blob/c443c44922ef13421f4a/classes/kohana/core.php#L5) you can see a markdown list and table. These are parsed and show correctly in the API browser. `@param`, `@uses`, `@throws`, `@returns` and other tags are parsed as well.
-## How to Contribute
-
-### If you don't know git, or you don't feel like you are a good documentation writer:
-
-Just submit a [bug report](http://dev.kohanaframework.org/projects/userguide3/issues/new) and explain what you think can be improved. If you are a good writer but don't know git, just provide some content in your bug report and we will merge it in.
-
-### If you know git:
-
-**Bluehawk's forks all have a `docs` branch. Please do all work in that branch.**
-
-To make pulling all the docs branches easier, the "docs" branch of [http://github.com/bluehawk/kohana](http://github.com/bluehawk/kohana) contains git submodule links to all the other "docs" branches, so you can clone that to easily get all the docs. The main Kohana docs are in [http://github.com/bluehawk/core/tree/docs/guide/kohana/], and docs for each module are in each module in the guide folder. (Again, make sure you are in the `docs` branch.)
-
-**Short version**: Fork bluehawk's fork of the module whose docs you wish to improve (e.g. `git://github.com/bluehawk/orm.git` or `git://github.com/bluehawk/core.git`), checkout the `docs` branch, make changes, and then send bluehawk a pull request.
-
-**Long version:** (This still assumes you at least know your way around git, especially how submodules work.)
-
- 1. Fork the specific repo you want to contribute to on github. (For example go to http://github.com/bluehawk/core and click the fork button.)
-
- 1. To make pulling the new userguide changes easier, I have created a branch of `kohana` called `docs` which contains git submodules of all the other doc branchs. You can either manually add my remotes to your existing kohana repo, or create a new kohana install from mine by doing these commands:
-
- git clone git://github.com/bluehawk/kohana
-
- # Get the docs branch
- git checkout origin/docs
-
- # Fetch the system folder and all the modules
- git submodule init
- git submodule update
-
- 1. Now go into the repo of the area of docs you want to contribute to and add your forked repo as a new remote, and push to it.
-
- cd system
-
- # make sure we are up to date with the docs branch
- git merge origin/docs
- (if this fails or you can't commit later type "git checkout -b docs" to create a local docs branch)
-
- # add your repository as a new remote
- git remote add <your name> git@github.com:<your name>/core.git
-
- # (make some changes to the docs)
-
- # now commit the changes and push to your repo
- git commit
- git push <your name> docs
-
- 1. Send a pull request on github.
-
-
# What the userguide adds to markdown:
In addition to the features and syntax of [Markdown](http://daringfireball.net/projects/markdown/) and [Markdown Extra](http://michelf.com/projects/php-markdown/extra/) the following apply to userguide pages and api documentation:
View
54 guide/userguide/contributing.md
@@ -1,5 +1,3 @@
-[!!] When the docs get merged these images/links should be update
-
# Contributing
Kohana is community driven, and we rely on community contributions for the documentation.
@@ -20,7 +18,7 @@ If you want to contribute some changes, you can do so right from your browser wi
First create an account on [Github](https://github.com/signup/free).
-You will need to fork the module for the area you want to improve. For example, to improve the [ORM documentation](../orm) fork <http://github.com/bluehawk/orm>. To improve the [Kohana documentation](../kohana), fork <http://github.com/bluehawk/core>, etc. So, find the module you want to improve and click on the Fork button in the top right.
+You will need to fork the module for the area you want to improve. For example, to improve the [ORM documentation](../orm) fork <http://github.com/kohana/orm>. To improve the [Kohana documentation](../kohana), fork <http://github.com/kohana/core>, etc. So, find the module you want to improve and click on the Fork button in the top right.
![Fork the module](contrib-github-fork.png)
@@ -38,42 +36,36 @@ Once your pull request has been accepted, you can delete your repository if you
## If you know git
-**Bluehawk's forks all have a `docs` branch. Please do all work in that branch.**
-
-To make pulling all the docs branches easier, the "docs" branch of [http://github.com/bluehawk/kohana](http://github.com/bluehawk/kohana) contains git submodule links to all the other "docs" branches, so you can clone that to easily get all the docs. The main Kohana docs are in [http://github.com/bluehawk/core/tree/docs/guide/kohana/], and docs for each module are in the respective module in the guide folder. (Again, make sure you are in the `docs` branch.)
-
-**Short version**: Fork bluehawk's fork of the module whose docs you wish to improve (e.g. `git://github.com/bluehawk/orm.git` or `git://github.com/bluehawk/core.git`), checkout the `docs` branch, make changes, and then send bluehawk a pull request.
+**Short version**: Fork the module whose docs you wish to improve (e.g. `git://github.com/kohana/orm.git` or `git://github.com/kohana/core.git`), checkout the `3.2/develop` branch (for the 3.2 docs!), make changes, and then send a pull request.
**Long version:** (This still assumes you at least know your way around git, especially how submodules work.)
- 1. Fork the specific repo you want to contribute to on github. (For example go to http://github.com/bluehawk/core and click the fork button.)
+ 1. Fork the specific repo you want to contribute to on github. (For example go to http://github.com/kohana/core and click the fork button.)
- 1. To make pulling the new userguide changes easier, I have created a branch of `kohana` called `docs` which contains git submodules of all the other doc branchs. You can either manually add my remotes to your existing kohana repo, or create a new kohana install from mine by doing these commands:
+ 1. Now you need to add your fork as a "git remote" to your application and ensure you are on the right branch. An example for the [ORM](../orm) module and 3.2 docs:
- git clone git://github.com/bluehawk/kohana
+ cd my-kohana-app/modules/orm
+
+ # add your repository as a new remote
+ git remote add <your name> git://github.com/<your name>/orm.git
- # Get the docs branch
- git checkout origin/docs
+ # Get the correct branch
+ git checkout 3.2/develop
- # Fetch the system folder and all the modules
- git submodule init
- git submodule update
-
1. Now go into the repo of the area of docs you want to contribute to and add your forked repo as a new remote, and push to it.
- cd system
-
- # make sure we are up to date with the docs branch
- git merge origin/docs
- (if this fails or you can't commit later type "git checkout -b docs" to create a local docs branch)
-
- # add your repository as a new remote
- git remote add <your name> git@github.com:<your name>/core.git
-
- # (make some changes to the docs)
+ cd my-kohana-app/modules/orm
+
+ # Make some changes to the docs
+ nano file.md
+
+ # Commit your changes - Use a descriptive commit message! If there is a redmine ticket for the changes you are making include "Fixes #XXXXX" in the commit message so its tracked.
+ git commit -a -m "Corrected a typo in the ORM docs. Fixes #12345."
- # now commit the changes and push to your repo
- git commit
- git push <your name> docs
+ # make sure we are up to date with the latest changes
+ git merge origin/3.2/develop
+
+ # Now push your changes to your fork.
+ git push <your name> 3.2/develop
- 1. Send a pull request on github.
+ 1. Finally, Send a pull request on github.

0 comments on commit b795e0f

Please sign in to comment.
Something went wrong with that request. Please try again.