From 2eae0ef81fe5b1dbf7a88974d8c0b82393e8c720 Mon Sep 17 00:00:00 2001 From: Johan Eklund Date: Sat, 28 Mar 2020 22:03:36 +0100 Subject: [PATCH] Fixed some styling in "Installation" chapter [ci skip] --- .../source/installation/installing_git.rst | 20 ++++++------- .../source/installation/repositories.rst | 28 +++++++++---------- .../source/installation/upgrade_4xx.rst | 2 +- 3 files changed, 23 insertions(+), 27 deletions(-) diff --git a/user_guide_src/source/installation/installing_git.rst b/user_guide_src/source/installation/installing_git.rst index 703a7a5f69f7..2995142e5ff4 100644 --- a/user_guide_src/source/installation/installing_git.rst +++ b/user_guide_src/source/installation/installing_git.rst @@ -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:: @@ -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 ------------------------------------------------------- @@ -69,7 +65,7 @@ Translations Installation If you wish to contribute to the system message translations, then fork and clone the `translations repository -`_ separately from the codebase. +`_ separately from the codebase. These are two independent repositories! diff --git a/user_guide_src/source/installation/repositories.rst b/user_guide_src/source/installation/repositories.rst index 0afe3f0e54ee..301915338a28 100644 --- a/user_guide_src/source/installation/repositories.rst +++ b/user_guide_src/source/installation/repositories.rst @@ -7,15 +7,15 @@ 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. @@ -23,16 +23,16 @@ The deployment repositories are built automatically when a new version is releas 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 @@ -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. diff --git a/user_guide_src/source/installation/upgrade_4xx.rst b/user_guide_src/source/installation/upgrade_4xx.rst index 4933ed2306e6..3c69ae1aa6d6 100644 --- a/user_guide_src/source/installation/upgrade_4xx.rst +++ b/user_guide_src/source/installation/upgrade_4xx.rst @@ -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**