Skip to content

Commit

Permalink
Merge pull request #2772 from jreklund/installation-git
Browse files Browse the repository at this point in the history
Fixed some styling in "Installation" chapter [ci skip]
  • Loading branch information
MGatner authored Apr 1, 2020
2 parents 88377e0 + 2eae0ef commit ca3ed2f
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 27 deletions.
20 changes: 8 additions & 12 deletions user_guide_src/source/installation/installing_git.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,6 @@ Install the latest version of the codebase by
Setting Up
-------------------------------------------------------

The command above will create a "CodeIgniter4" folder.
Feel free to rename that as you see fit.

You will want to set up a remote repository alias, so you can synchronize
your repository with the main one::

Expand All @@ -37,24 +34,23 @@ Update your code anytime::
git pull upstream develop
git push origin develop

Merge conflicts may arise when you pull from "upstream".
Merge conflicts may arise when you pull from "upstream".
You will need to resolve them locally.

Pros
-------------------------------------------------------

- You have the latest version of the codebase (unreleased)
- You can propose contributions to the framework, by creating a
feature branch and submitting a pull request for it to the main repo
- a pre-commit hook is installed for your repo, that binds it to the
coding-standard we use
- You can propose contributions to the framework, by creating a
feature branch and submitting a pull request for it to the main repo
- A pre-commit hook is installed for your repo, that binds it to the
coding-standard we use

Cons
-------------------------------------------------------

You need to resolve merge conflicts when you synch with the repo.

You would not use this technique for app development.
- You need to resolve merge conflicts when you synch with the repo.
- You would not use this technique for app development.

Structure
-------------------------------------------------------
Expand All @@ -69,7 +65,7 @@ Translations Installation

If you wish to contribute to the system message translations,
then fork and clone the `translations repository
<https://github.com/codeigniter4/translations>`_ separately from the codebase.
<https://github.com/codeigniter4/translations>`_ separately from the codebase.
These are two independent repositories!


Expand Down
28 changes: 14 additions & 14 deletions user_guide_src/source/installation/repositories.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,32 +7,32 @@ The CodeIgniter 4 open source project has its own
There are several development repositories, of interest to potential contributors:

+------------------+--------------+-----------------------------------------------------------------+
+ Repository + Audience + Description +
| Repository | Audience | Description |
+==================+==============+=================================================================+
+ CodeIgniter4 + contributors + Project codebase, including tests & user guide sources +
| CodeIgniter4 | contributors | Project codebase, including tests & user guide sources |
+------------------+--------------+-----------------------------------------------------------------+
+ translations + developers + System message translations +
| translations | developers | System message translations |
+------------------+--------------+-----------------------------------------------------------------+
+ coding-standard + contributors + Coding style conventions & rules +
| coding-standard | contributors | Coding style conventions & rules |
+------------------+--------------+-----------------------------------------------------------------+
+ + + +
| | | |
+------------------+--------------+-----------------------------------------------------------------+

There are also several deployment repositories, referenced in the installation directions.
The deployment repositories are built automatically when a new version is released, and they
are not directly contributed to.

+------------------+--------------+-----------------------------------------------------------------+
+ Repository + Audience + Description +
| Repository | Audience | Description |
+==================+==============+=================================================================+
+ framework + developers + Released versions of the framework +
| framework | developers | Released versions of the framework |
+------------------+--------------+-----------------------------------------------------------------+
+ appstarter + developers + Starter project (app/public/writable). +
+ + + Dependent on "framework" +
| appstarter | developers | Starter project (app/public/writable). |
| | | Dependent on "framework" |
+------------------+--------------+-----------------------------------------------------------------+
+ userguide + anyone + Pre-built user guide +
| userguide | anyone | Pre-built user guide |
+------------------+--------------+-----------------------------------------------------------------+
+ + + +
| | | |
+------------------+--------------+-----------------------------------------------------------------+

In all the above, the latest version of a repository can be downloaded
Expand Down Expand Up @@ -62,11 +62,11 @@ on Github as well, with projects that are not part of the framework,
but which showcase it or make it easier to work with!

+------------------+--------------+-----------------------------------------------------------------+
+ Repository + Audience + Description +
| Repository | Audience | Description |
+==================+==============+=================================================================+
+ website2 + developers + The codeigniter.com website, written in CodeIgniter 4 +
| website2 | developers | The codeigniter.com website, written in CodeIgniter 4 |
+------------------+--------------+-----------------------------------------------------------------+
+ + + +
| | | |
+------------------+--------------+-----------------------------------------------------------------+

These are not composer-installable repositories.
2 changes: 1 addition & 1 deletion user_guide_src/source/installation/upgrade_4xx.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ subforum for an up-to-date list!
**Downloads**

- CI4 is still available as a ready-to-run zip or tarball, which
includes the user guide (though in the `docs` subfolder
includes the user guide (though in the `docs` subfolder)
- It can also be installed using Composer

**Namespaces**
Expand Down

0 comments on commit ca3ed2f

Please sign in to comment.