Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions src/page/Build.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,18 @@ VERSION.m4 file before you execute the build.
Building from the git
---------------------

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

``$ git clone https://pagure.io/freeipa.git``
In order to get more familiar with git submodule concepts, you can read
`git submodules <https://git-scm.com/book/en/v2/Git-Tools-Submodules>`__.

You can clone the FreeIPA repository and its submodules using the following
command:

``$ git clone --recurse-submodules https://pagure.io/freeipa.git``

Next, we will install all packages needed to build FreeIPA as they do
not have to be installed on your system. You can install them easily by
Expand Down
14 changes: 12 additions & 2 deletions src/page/Contribute/Code.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,16 @@ whole new feature! The steps below should help get you started.
If you need to learn more about FreeIPA itself, visit the `main
page <Main_Page>`__.

The Modern WebUI is a separate project that is stored in a submodule of
the FreeIPA repository. It is available at
`freeipa-webui <https://github.com/freeipa/freeipa-webui>`__ and
installed in the directory ``install/freeipa-webui``. You can see the
issues for Modern WebUI at
`freeipa-webui issues <https://github.com/freeipa/freeipa-webui/issues>`__.

Most of the development for Modern WebUI is similar to the development of
FreeIPA, for more specifics, please refer to the links above.



Find something to start with
Expand Down Expand Up @@ -70,11 +80,11 @@ Get the source
--------------

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

::

git clone https://pagure.io/freeipa.git
git clone --recurse-submodules https://pagure.io/freeipa.git

The code can also be browsed online
`here <https://pagure.io/freeipa/commits>`__
Expand Down
29 changes: 25 additions & 4 deletions src/page/Pull_request_on_Github.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Pull_request_on_Github
Pull request on Github
======================

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

::

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

Create a new branch (from master)

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

Please put link to your pull request to ticket field *Patch link* (if
fixes any ticket).
fixes any ticket).

Modern WebUI
^^^^^^^^^^^^

Modern WebUI is a separate project that is stored in a submodule of the
FreeIPA repository. It is available at
`freeipa-webui <https://github.com/freeipa/freeipa-webui>`__ and
installed in the directory ``install/freeipa-webui``.

In order to get more familiar with git submodule concepts, you can read
`git submodules <https://git-scm.com/book/en/v2/Git-Tools-Submodules>`__.

Cloning the FreeIPA repository and developing in the subdirectory should be
enough, but it is also possible to develop Modern WebUI separately using:

``$ git clone https://github.com/freeipa/freeipa-webui``

The other processes are similar.

Do note, that all of the development for Modern WebUI is done on
`GitHub <https://github.com/freeipa/freeipa-webui>`__, not on Pagure.
13 changes: 12 additions & 1 deletion src/page/Release.md
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@ Building the sources
If doing a pre release pull a fresh tree to do the builds into a separate directory:

```
$ git clone [https://pagure.io/freeipa.git](https://pagure.io/freeipa.git) freeipa-x-y-z
$ git clone --recurse-submodules [https://pagure.io/freeipa.git](https://pagure.io/freeipa.git) freeipa-x-y-z
$ cd freeipa-x-y-z
```

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

This should also checkout the correct version of Modern WebUI.

You can check that the correct version of Modern WebUI is checked out by
running:

```
$ git status
```

There should be no modifications.

### Create tarball

#### IPA 4.5+
Expand Down