Skip to content

Commit 6c57e25

Browse files
DEiseltggainey
authored andcommitted
Update quickstart for 'Contribute with Code'
The steps for a minimal dev setup were out of order. They also missed some context to avoid confusion. Furthermore some of the links for "more comprehensive guides" pointed at the current page instead of the intended docs pages. closes #7319
1 parent 6d896e8 commit 6c57e25

2 files changed

Lines changed: 15 additions & 10 deletions

File tree

CHANGES/7319.doc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Fixed the quickstart instructions on how to contribute with code as well as links to more comprehensive guides.

docs/dev/tutorials/quickstart.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,28 +15,32 @@ It is a CLI tool that uses `docker/podman-compose` and [Pulp OCI Images](https:/
1515
To set it up, follow these steps:
1616

1717
```bash
18-
# 1. clone repos to the same basedir (pulpcore is required)
18+
# 1. clone required repos to the same basedir
1919
git clone https://github.com/pulp/oci_env.git
2020
git clone https://github.com/pulp/pulpcore.git
21+
git clone https://github.com/pulp/pulp-openapi-generator.git # required for 'generate-client' below
22+
23+
# 1.1 add more repos as necessary to the same basedir
2124
git clone https://github.com/pulp/pulp_rpm.git
2225

2326
# 2. install oci-env client
2427
cd oci_env
2528
pip3 install -e client
2629

2730
# 3. use minimal compose.env
31+
# At least add pulpcore to DEV_SOURCE_PATH like this: DEV_SOURCE_PATH=pulpcore
2832
cp compose.env.example compose.env
2933

30-
# 4. build the images and do basic setup
34+
# 4. build the images and start the service
3135
oci-env compose build
36+
oci-env compose up
37+
38+
# 5. do basic setup
3239
oci-env generate-client -i
3340
oci-env generate-client -i pulp_file
34-
35-
# 5. start the service
36-
oci-env compose up
3741
```
3842

39-
A more comprehensive guide on setting up the dev environment is documented [here](#).
43+
A more comprehensive guide on setting up the dev environment is documented [here](site:oci_env/docs/dev/tutorials/quickstart/).
4044

4145
### 2. Make and test changes
4246

@@ -52,11 +56,11 @@ oci-env test -i -p pulp_rpm functional
5256
oci-env test -p pulp_rpm functional -k test_mychages
5357
```
5458

55-
A more comprehensive guide on running tests is documented [here](#).
59+
A more comprehensive guide on running tests is documented [here](site:oci_env/docs/dev/guides/run-tests/).
5660

5761
### 3. Update the changelog entry
5862

59-
Pulp uses [towncrier](#) to manage its changelog.
63+
Pulp uses [towncrier](https://towncrier.readthedocs.io/en/stable/) to manage its changelog.
6064

6165
It requires that you have a related GitHub issue number, except for trivial changes (such as typo fixes).
6266
In those cases the entry is no required at all.
@@ -83,7 +87,7 @@ The changelog message should use past simple tense and describe the change being
8387
echo "Added API that allows users to export a repository version to disk." > CHANGES/plugin_api/3245.feature
8488
```
8589

86-
A more comprehensive guide on using towncrier in the Pulp project is documented [here](#).
90+
A more comprehensive guide on using towncrier in the Pulp project is documented [here](site:pulpcore/docs/dev/guides/git/#changelog-update).
8791

8892
### 4. Commit and Submit a PR
8993

@@ -108,4 +112,4 @@ the worker configuration.
108112
closes #1392
109113
```
110114

111-
A more comprehensive guide on using git in the Pulp project is documented [here](#).
115+
A more comprehensive guide on using git in the Pulp project is documented [here](site:pulpcore/docs/dev/guides/git/).

0 commit comments

Comments
 (0)