Commit Graph

576 Commits

Author SHA1 Message Date
Jeremy Stanley 08eea5856c Document Gerrit service SSH host key fingerprints
At some point, the Gerrit WebUI ceased displaying SSH host key
details, so go ahead and bake them into our Developer's Guide and
cross-link to them from the appropriate part of the Getting Started
chapter too.

While we're here, add a link from Getting Started to the Developer's
Guide section on the OpenStack ICLA, as users following these
instructions may see errors about that when trying to set up to
contribute to a repository which enforces it.

Change-Id: I9ea5cc9952a0fd4a2bd45fd0ba3e97f8acc7b920
2023-09-13 15:18:16 +00:00
Zuul e40ff9d3c5 Merge "PyPI: clarify case where owner can't be removed" 2023-07-11 13:13:08 +00:00
Jay Faulkner 75b74b0668 PyPI: clarify case where owner can't be removed
If you can't remove your owner-user, it means you didn't give
openstackci owner access. Make the docs explicitly say that.

Change-Id: Iadb8f2f4061bab374a00951e00e5ca45c83c144a
2023-03-22 10:37:52 -07:00
Jay Faulkner 64f67bcdcc Trivial: fix image sizing in creators guide
This corrects the ratio to match the image and reduce the squishing
effect. The new numbers represent half the size of the original image,
rounded to the nearest whole number.

Change-Id: I0639dda347df10cff256aa2ccc47ec736378472e
2023-03-15 14:18:03 -07:00
Zuul dd6cc52a77 Merge "Add documentation on removing human user from pypi" 2023-02-23 00:58:11 +00:00
Jay Faulkner da2d9bd83a Add documentation on removing human user from pypi
PyPI is safest when we leave the robots to release things; document this
in the guide.

Change-Id: I6e77c6a44e62caea4e63b01f9baf60b48a80a2d7
2023-02-20 15:02:45 -08:00
Jeremy Stanley 827bc802b3 Update subsection on Using Secrets
Fix the broken URL to Zuul's documentation on secrets and switch to
recommending the zuul-client utility instead of the deprecated
encrypt_secret.py script.

Change-Id: I508b32011a128a76344265a1ba511d6613a7f393
2023-02-17 13:17:36 +00:00
Jeremy Stanley 5e063d7f1d General updates for the Test Environment chapter
Test Environment hasn't been touched in a while and needs a bit of a
refresh to reflect changes to our systems in recent years as well as
removing some OpenStackisms and a bit of rewording in places for
added clarity.

Change-Id: I69156ed7ef88d9584638d59825d44f982d0cf4b4
2023-01-30 18:15:58 +00:00
Jeremy Stanley f281c80e5c Stop recommending PyPI project name squatting
For years now, Warehouse (PyPI) has supported automatic project
registration on initial upload. The reason our "registration"
instructions got so complicated, in fact, is that they discouraged
and then entirely stopped supporting any other method of project
registration in order to help curb namesquatting. OpenStack's
release automation has support for this workflow as well, so let's
stop being part of the problem.

Depends-On: https://review.opendev.org/852574
Change-Id: I00a72fd330a24f548b9c87cab852cf3f57d5e910
2022-08-09 14:03:40 +00:00
Jeremy Stanley 6e166e7581 Update recommended ACL for createSignedTag keyword
In Ia426ea36b4e6877fdce5725ff1e00ae02c62e3f4 we switched from
pushSignedTag to creaeSignedTag in all our Gerrit project ACLs, so
update examples in our documentation accordingly. The old syntax is
no longer allowed by our ACL linter.

Change-Id: Ie7cca062844101a685befe3b4f5d868b9506c5c0
2022-01-25 17:50:42 +00:00
Dr. Jens Harbott b303896a75 Update description of our testing environment
In particular be more specific about us not mirroring certain sites like
PyPi, but just cache accesses.

Signed-off-by: Dr. Jens Harbott <harbott@osism.tech>
Change-Id: I3fc4856b39a4561450b666cb9c381814cd0dd9a3
2021-11-03 12:00:44 +01:00
Jeremy Stanley 735e66ee78 Re-add suggestion to register IRC nicks
Nick registration is no longer required to join the channels we
manage, but it's still a good idea. Since OFTC does provide a few
words on the process, add some sentences linking to that.

Change-Id: I744844a9a9e134dfddf2f170059a8b51563ecde1
2021-07-08 13:37:36 +00:00
Jeremy Stanley 87d6088053 Switch docs from referencing Freenode to OFTC
We moved our services to OFTC at the end of May, 2021. Update all
old Freenode references in the manual, and also drop mention of
registering nicks as this is not currently required to join channels
we serve.

Change-Id: Icd9005802c891d3637ac13804b36aa960b616a2c
2021-06-22 19:36:33 +00:00
Jeremy Stanley 2f8567a829 Update branch creation for PolyGerrit
The new Polymer-based Gerrit WebUI has rearranged a number of
options, labels and general terminology. Revise the Drivers Guide
section on Branch Creation to match what users see now. Also refer
to Gerrit's documentation about the create reference permission, as
well as its REST API and CLI branch creation alternatives. Remove
misleading references to creation via git push, and instead indicate
that does not work.

Change-Id: I5aff0911677be1e0300728f63fb6a1ab02d30362
2021-04-15 22:27:58 +00:00
Zuul 7d7155d790 Merge "Restore Zuul v3 Migration Guide bits on secrets" 2020-09-17 18:44:47 +00:00
Zuul 1dac4fbcca Merge "Retirement: Make clearer that we need README.rst" 2020-06-22 19:08:15 +00:00
Andreas Jaeger 5b9a2406b0 Retirement: Make clearer that we need README.rst
The redirects from docs.o.o are to README.rst, not README.md - always
speak about README.rst in the retirment instructions.

Change-Id: I50f3e677d62d94b2ff791531290c3e73c3f86109
2020-06-20 17:10:21 +02:00
Andreas Jaeger f3ae0aa69d Clarify retirement instructions
We ask to link all changes with depends-on/needed-by -and then say "Wait
here". Let's write that clearer.

Change-Id: Id77c3aa1d6268ea5236f673df610584c846f97f0
2020-06-18 16:19:01 +02:00
Mohammed Naser 1957a16952 creators: add warning about zuul config and importing
We need our users to know that all branches will be imported and that
the repository cannot have any Zuul configuration.

Change-Id: I19faa9c0671a2121364b4607c80daf268a73f286
2020-06-17 10:43:52 -04:00
Andreas Jaeger e138b8d5db Project Retirement: Document job changes
Make projects aware that they need to work with others that require
their  project in testing.

Change-Id: I48bb9540491baa221b41bb1e5a1ff6df937726a6
2020-06-16 11:27:56 +02:00
Roman Gorshunov 9636490de8 Minor yaml format fix in documentation
Change-Id: I541fb25704fc6008e0325aed75138423319051d1
2020-04-22 16:50:35 +02:00
Jeremy Stanley f203ad8c5b Update contact info for OpenDev community
The OpenDev community has a new service discussion list and has also
moved to a new IRC channel. Update the contact information in the
manual to be more current.

Change-Id: I2c4f5e65e2e6f3c066d1bc6225661acc690ef945
2020-04-07 19:13:41 +00:00
Thierry Carrez 1ca0419bce Split "Getting started" from "Developer's Guide"
Now that the Developer's Guide is directly linked to from the
opendev.org webpage, start with a brief introduction of the
steps necessary to interact with it, rather than comprehensive
(and intimidating) reference documentation.

Change-Id: If9244c1819ab38676466d821be0b5104b6852c47
2020-03-30 16:33:40 +02:00
Clark Boylan 24b31654a4 Use alabaster theme
We are trying to make this documentation less openstack specific. We
should stop using the openstack sphinx theme as a result. Use alabaster
is it is nice and clean and allows us to set our logo.

Change-Id: Icb772f6a52803af53ece419cc3908bdd8e2faad0
2020-03-27 09:28:57 -07:00
Jeremy Stanley 97a44f6d7c Restore Zuul v3 Migration Guide bits on secrets
Change I0965ef2de95700e466c30de412f0317d0554641c removed the Zuul v3
Migration Guide, and with it our user documentation about handling
and using Zuul secrets. Add these back to appropriate sections of
the manual, slightly revised for their new contexts.

Change-Id: I63dc4711e81bec5325889e1b6c678399f846ed69
2020-03-23 21:11:06 +00:00
Zuul 9c9eecd659 Merge "Follow infra-manual move to opendev" 2020-03-20 19:25:56 +00:00
Andreas Jaeger 2e062a5857 Update .gitreview after rename
The repo got moved from openstack/infra-manual to opendev/infra-manual,
update .gitreview for this.

Change-Id: I9c82e490bc3109857f1c410ec33a37c6a8e2a8ad
2020-03-20 16:07:06 +01:00
Andreas Jaeger 23330114e5 Follow infra-manual move to opendev
Update places that speak about openstack/infra-manual to
opendev/infra-manual.

Depends-On: https://review.opendev.org/712149
Change-Id: I1aec34fd66fa1093ed41cadd017bbe3fcb5753b4
2020-03-19 17:36:48 +01:00
Zuul f7ef525e4b Merge "Move Translation setup to i18n document" 2020-03-11 20:29:06 +00:00
Zuul c6d8b04c2d Merge "Remove OpenStack specific steps from project retirement/rename" 2020-03-11 20:29:06 +00:00
Zuul 52390060b9 Merge "Update Feature branches, releases sections for OpenStack" 2020-03-11 20:26:04 +00:00
Andreas Jaeger b761af7fd3 Remove OpenStack specific steps from project retirement/rename
For Retirement:
Two of the 5 steps are OpenStack specific, remove them.

For rename: Some instructions are OpenStack specific, remove them.

Change https://review.opendev.org/712534 adds these steps to the
project-team-guide.

Change-Id: I8c1aca854512ebcee54fc5c203ed3a0336ab1a05
2020-03-11 20:20:35 +01:00
Andreas Jaeger 0c1134e8dd Move Translation setup to i18n document
The translation setup is OpenStack specific, move it to the i18n
repository.

Depends-On: https://review.opendev.org/711826
Change-Id: I5919bb97527f343fbbf7a01e836cbe607f460e35
2020-03-11 20:07:36 +01:00
Andreas Jaeger 9d9b958503 Update Feature branches, releases sections for OpenStack
Remove OpenStack specific content, the Project Team Guide covers this.

Rework to have a common "Branches" section and then go into feature and
stable branches and have this generic for OpenDev projects.

Change-Id: I6169ca0414ae818dca1751b863f98517c043903e
2020-03-11 18:24:18 +01:00
Zuul c85d027a2b Merge "Remove section "Updating devstack-vm-gate-wrap.sh"" 2020-03-11 14:45:25 +00:00
Andreas Jaeger 5e0e0af368 Remove section "Updating devstack-vm-gate-wrap.sh"
This section is not relevant anymore, new repos should not use
devstack-gate. Remove it.

Change-Id: I6291f8c5dcaf22e64437a7de1a06ceaf4911fd52
2020-03-07 16:54:10 +01:00
Andreas Jaeger ac584aecaa Fix Peer Review section formatting
https://docs.openstack.org/infra/manual/developers.html#peer-review is
wrongly formatted, remove the extra indent that makes it preformatted
instead of a list.

Change-Id: I842814aa916bc8116c8889638d2a907214441da9
2020-03-07 16:50:48 +01:00
Zuul e405053a4e Merge "Update "Code Review" for OpenDev" 2020-03-06 22:52:03 +00:00
Zuul f268ee1def Merge "Remove "Eligibility to Vote in Elections" section" 2020-03-06 22:52:02 +00:00
Zuul ac74477426 Merge "Update 'Feature Branches' for OpenDev" 2020-03-06 22:47:12 +00:00
Zuul abe2d4b22a Merge "Redraw code_review image" 2020-03-06 22:46:20 +00:00
Zuul c05472340e Merge "Update "Outbound Third-Party Testing" for OpenDev" 2020-03-06 19:09:34 +00:00
Andreas Jaeger 9a98cba3a8 Redraw code_review image
Add also an svg as editable format.

Change-Id: I04d55fc3305d53edf41500e38426720aab4b272c
2020-03-06 19:35:17 +01:00
Zuul 9787815a69 Merge "Update sandbox intro for OpenDev" 2020-03-06 18:32:52 +00:00
Zuul 1238b6f5ac Merge "Document why drafts are disabled" 2020-03-06 18:32:04 +00:00
Zuul be857f4e54 Merge "Update elastic-recheck comment" 2020-03-06 18:28:58 +00:00
Andreas Jaeger cb6adb8aec Update 'Feature Branches' for OpenDev
Rework section for OpenStack -> OpenDev.

Change-Id: Ic52982878dee7a737aad48914b404590519e71e2
2020-03-06 17:38:22 +01:00
Andreas Jaeger 7895875b6a Remove "Eligibility to Vote in Elections" section
Remove this OpenStack specific section, it's migrated now to the
OpenStack Contributor Guide.

See also https://review.opendev.org/711531

Change-Id: I42f2110e0956b5b5c68225fde1e081cef1a7bbca
2020-03-06 15:55:32 +00:00
Andreas Jaeger 0ecacdde0c Update "Code Review" for OpenDev
Generalize content for OpenDev, mark OpenStack specifics as such.

Fix description of +A button.

Change-Id: I39db553fc29f94f7ec9bc7c90f715573f85d51d7
2020-03-06 16:31:40 +01:00
Zuul 7e9f14e46e Merge "Update Driver's Guide for OpenDev" 2020-03-06 15:29:34 +00:00