Summary

Update the CI Integration docs.

Review Request #13941 — Created June 5, 2024 and submitted June 5, 2024, 10:10 p.m.

Information

Owner

maubin

Repository

Review Board

Branch

release-7.x

Bugs

Depends On

Reviewers

Groups

reviewboard

People

Description

This updates all of our CI integration docs according to the new changes coming
in RB integrations 4.0.

Testing Done

Built and viewed the docs in my RB6 dev tree and in RB7.

Commits

Summary	ID
Update the CI Integration docs.	9c375f3578bf9a0124835eca42eebc484b395b2d

Issues

Description	From	Last Updated
Can we link to the docs here?	chipx86	June 5, 2024, 4:07 p.m.
It may be better to use the same key/value syntax we're using for the fields. As-is, I don't think ReST …	chipx86	June 5, 2024, 4:09 p.m.
While here, let's make this, say, 3.12.	chipx86	June 5, 2024, 4:10 p.m.
And then let's change this to: - pip install -e . Especially since setup.py develop is considered legacy and going …	chipx86	June 5, 2024, 4:10 p.m.
And maybe pytest here.	chipx86	June 5, 2024, 4:12 p.m.
Two blank lines between content and reference declarations.	chipx86	June 5, 2024, 4:12 p.m.

flake8 passed.

JSHint passed.

Thanks again for taking this on!

Since testing is busted on RB7 right now, you could try copying these over to RB6 and testing there.

maubin June 5, 2024, 4:17 p.m.

I did end up building/viewing the docs in RB6 (I mention it in the "Testing Done" section :P).

docs/manual/admin/integrations/circle-ci.rst (Diff revision 1)
The issue has been resolved. Show all issues
```
Can we link to the docs here?
```

docs/manual/admin/integrations/jenkins-ci.rst (Diff revision 1)

The issue has been resolved. Show all issues

It may be better to use the same key/value syntax we're using for the fields.

As-is, I don't think ReST will format these right, since spaces are generally treated as significant characters, and can alter the display of the content. It normally has to align with the list item.

Also, ReST requires double-backticks for literals. Singles are for a type of references we don't use.

maubin June 5, 2024, 4:17 p.m.
```
Ah yep, this way looks better.
```

docs/manual/admin/integrations/travis-ci.rst (Diff revision 1)
The issue has been resolved. Show all issues
```
While here, let's make this, say, 3.12.
```

docs/manual/admin/integrations/travis-ci.rst (Diff revision 1)

The issue has been resolved. Show all issues

And then let's change this to:

- pip install -e .

Especially since setup.py develop is considered legacy and going away.

docs/manual/admin/integrations/travis-ci.rst (Diff revision 1)
The issue has been resolved. Show all issues
```
And maybe pytest here.
```
docs/manual/admin/integrations/travis-ci.rst (Diff revision 1)
The issue has been resolved. Show all issues
```
Two blank lines between content and reference declarations.
```

Commits:

	Summary	ID
	Update the CI Integration docs.	29ac3364fed67e08657952a0c1ab34d780c47a72
	Update the CI Integration docs.	9076b86d5f3ef3d66c035dcf40e67301f9b6d15c

Diff:

Revision 2 (+528 -198)

Show changes

	docs/manual/admin/integrations/circle-ci.rst
	docs/manual/admin/integrations/jenkins-ci.rst
	docs/manual/admin/integrations/travis-ci.rst

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Testing Done:

~		Built and viewed the docs in my RB6 dev tree.
	~	Built and viewed the docs in my RB6 dev tree and in RB7.

Commits:

	Summary	ID
	Update the CI Integration docs.	9076b86d5f3ef3d66c035dcf40e67301f9b6d15c
	Update the CI Integration docs.	9c375f3578bf9a0124835eca42eebc484b395b2d

Diff:

Revision 3 (+534 -198)

Show changes

	docs/manual/admin/integrations/circle-ci.rst
	docs/manual/admin/integrations/jenkins-ci.rst
	docs/manual/admin/integrations/travis-ci.rst

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-7.x (f0c2966)