Skip to content

Commit aef46c5

Browse files
duzdaabbra
authored andcommitted
Add Modern WebUI
I have left the legacy pages with no changes, as they imo shouldn't be updated, to reflect the new changes. Signed-off-by: David Hanina <[email protected]>
1 parent e55b738 commit aef46c5

File tree

4 files changed

+60
-9
lines changed

4 files changed

+60
-9
lines changed

src/page/Build.rst

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,18 @@ VERSION.m4 file before you execute the build.
3333
Building from the git
3434
---------------------
3535

36-
First, clone our git tree of your project:
36+
FreeIPA git repository is using another project as a git submodule to store
37+
the source code for its new webui. The submodule is available at
38+
`freeipa-webui <https://github.com/freeipa/freeipa-webui>`__ and
39+
installed in the directory ``install/freeipa-webui``.
3740

38-
``$ git clone https://pagure.io/freeipa.git``
41+
In order to get more familiar with git submodule concepts, you can read
42+
`git submodules <https://git-scm.com/book/en/v2/Git-Tools-Submodules>`__.
43+
44+
You can clone the FreeIPA repository and its submodules using the following
45+
command:
46+
47+
``$ git clone --recurse-submodules https://pagure.io/freeipa.git``
3948

4049
Next, we will install all packages needed to build FreeIPA as they do
4150
not have to be installed on your system. You can install them easily by

src/page/Contribute/Code.rst

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,16 @@ whole new feature! The steps below should help get you started.
1010
If you need to learn more about FreeIPA itself, visit the `main
1111
page <Main_Page>`__.
1212

13+
The Modern WebUI is a separate project that is stored in a submodule of
14+
the FreeIPA repository. It is available at
15+
`freeipa-webui <https://github.com/freeipa/freeipa-webui>`__ and
16+
installed in the directory ``install/freeipa-webui``. You can see the
17+
issues for Modern WebUI at
18+
`freeipa-webui issues <https://github.com/freeipa/freeipa-webui/issues>`__.
19+
20+
Most of the development for Modern WebUI is similar to the development of
21+
FreeIPA, for more specifics, please refer to the links above.
22+
1323

1424

1525
Find something to start with
@@ -70,11 +80,11 @@ Get the source
7080
--------------
7181

7282
The source `repository <https://www.freeipa.org/page/Repository>`__ for FreeIPA is stored
73-
in git. Retrieve it with:
83+
in git. Retrieve it and its submodules with:
7484

7585
::
7686

77-
git clone https://pagure.io/freeipa.git
87+
git clone --recurse-submodules https://pagure.io/freeipa.git
7888

7989
The code can also be browsed online
8090
`here <https://pagure.io/freeipa/commits>`__

src/page/Pull_request_on_Github.rst

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Pull_request_on_Github
1+
Pull request on Github
22
======================
33

44
At first you have to create your own fork of FreeIPA on
@@ -10,9 +10,9 @@ repository (cloned from fedorahosted)
1010

1111
::
1212

13-
$ git clone ``\ ```https://pagure.io/freeipa.git`` <https://pagure.io/freeipa.git>`__
13+
$ git clone --recurse-submodules https://pagure.io/freeipa.git
1414
$ cd freeipa/
15-
$ git remote add myfork [email protected]:``\ ``/freeipa.git
15+
$ git remote add myfork [email protected]:/freeipa.git
1616

1717
Create a new branch (from master)
1818

@@ -40,4 +40,25 @@ When pull request is created, FreeIPA developers are automatically
4040
notified. All review will happen on Github.
4141

4242
Please put link to your pull request to ticket field *Patch link* (if
43-
fixes any ticket).
43+
fixes any ticket).
44+
45+
Modern WebUI
46+
^^^^^^^^^^^^
47+
48+
Modern WebUI is a separate project that is stored in a submodule of the
49+
FreeIPA repository. It is available at
50+
`freeipa-webui <https://github.com/freeipa/freeipa-webui>`__ and
51+
installed in the directory ``install/freeipa-webui``.
52+
53+
In order to get more familiar with git submodule concepts, you can read
54+
`git submodules <https://git-scm.com/book/en/v2/Git-Tools-Submodules>`__.
55+
56+
Cloning the FreeIPA repository and developing in the subdirectory should be
57+
enough, but it is also possible to develop Modern WebUI separately using:
58+
59+
``$ git clone https://github.com/freeipa/freeipa-webui``
60+
61+
The other processes are similar.
62+
63+
Do note, that all of the development for Modern WebUI is done on
64+
`GitHub <https://github.com/freeipa/freeipa-webui>`__, not on Pagure.

src/page/Release.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@ Building the sources
207207
If doing a pre release pull a fresh tree to do the builds into a separate directory:
208208

209209
```
210-
$ git clone [https://pagure.io/freeipa.git](https://pagure.io/freeipa.git) freeipa-x-y-z
210+
$ git clone --recurse-submodules [https://pagure.io/freeipa.git](https://pagure.io/freeipa.git) freeipa-x-y-z
211211
$ cd freeipa-x-y-z
212212
```
213213

@@ -217,6 +217,17 @@ Make absolutely sure I have the right code by switching to the tag:
217217
$ git checkout release-x-y-z
218218
```
219219

220+
This should also checkout the correct version of Modern WebUI.
221+
222+
You can check that the correct version of Modern WebUI is checked out by
223+
running:
224+
225+
```
226+
$ git status
227+
```
228+
229+
There should be no modifications.
230+
220231
### Create tarball
221232

222233
#### IPA 4.5+

0 commit comments

Comments
 (0)