Skip to content

Add zuul user documentation draft #54

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 22 commits into from
Sep 29, 2023
Merged

Add zuul user documentation draft #54

merged 22 commits into from
Sep 29, 2023

Conversation

master-caster
Copy link
Contributor

No description provided.

Add zuul user documentation draft
522699b 
Signed-off-by: Benjamin Zapiec <zapiec@gonicus.de>
Benjamin Zapiec added 6 commits August 25, 2023 13:45
add parantheses
ab0c8f9 
Signed-off-by: Benjamin Zapiec <zapiec@gonicus.de>
add text for the link
1b3996f 
Signed-off-by: Benjamin Zapiec <zapiec@gonicus.de>
fenced code blocks do have a type now
ed06e45 
Signed-off-by: Benjamin Zapiec <zapiec@gonicus.de>
add blanks to jusity check
f1aa9ad 
Signed-off-by: Benjamin Zapiec <zapiec@gonicus.de>
add/remove blanks/whitespaces to jusity check
7f76772 
Signed-off-by: Benjamin Zapiec <zapiec@gonicus.de>
update filename to see its purpose
a5d95c6 
Signed-off-by: Benjamin Zapiec <zapiec@gonicus.de>
mbuechse
mbuechse requested changes Aug 28, 2023
View reviewed changes
fkr
fkr reviewed Aug 28, 2023
View reviewed changes
operations/operations/zuul-ci-cd-quickstart-user-guide.md Outdated
Comment on lines 26 to 29
Right in your projects repository! The only prerequisite you need to fulfill, is that
your repository you want zuul to work on is known by zuul. This is done by the zuuls
tenant configuration. To update this configuration you need access to the zuul instance
or ask an administrator for help.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should add exactly what is to be done, eg.

"Contact the SCS Zuul operators at foo@" or establish a similar workflow as with the OpenStack projects flow for the gx-scs demonstrator.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would keep it as it is

Right in your projects repository! The only prerequisite you need to fulfill, is that
your repository you want zuul to work on is known by zuul. This is done by the zuuls
tenant configuration. To update this configuration you need access to the zuul instance
or ask an administrator for help.

and add

To do so get in touch by contacting .......

Would that be sufficient? And if so which e-mail address / phone number / matrix account to add? 😁

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We concluded in today's team OPS call that we will document as follows:

Please open an issue to have your repository added to zuul using the proper template in the issues repository.
PR for the template is here: SovereignCloudStack/issues#436

@fkr
Copy link
Member

fkr commented Aug 28, 2023

I'd like to have one of the dNations people looking at this and see wether they have everything they need to do substitute their zuul with the SCS one. @matofeder @chess-knight @fdobrovolny

garloff pushed a commit that referenced this pull request Aug 28, 2023
@maxwolfs
update modules (#54)
751f212 
Signed-off-by: Max Wolfs <mail@maxwolfs.com>
add an example of where to store the zuul configuration
baeebd7 
add a link to check the known projects
explicit use scs zuul

Signed-off-by: Benjamin Zapiec <zapiec@gonicus.de>
@master-caster
Copy link
Contributor Author

  • Change to explicit use SCS Zuul
  • Add an overview of the possible files / directories for zuul

update the zuul configuration files example
4d5f788 
Signed-off-by: Benjamin Zapiec <zapiec@gonicus.de>
matofeder
matofeder reviewed Aug 29, 2023
View reviewed changes
@mbuechse mbuechse self-requested a review September 12, 2023 08:54
osfrickler
osfrickler requested changes Sep 12, 2023
View reviewed changes
Copy link
Contributor

@osfrickler osfrickler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please mark comments that have been addressed as resolved, this is getting rather difficult to track.

mbuechse
mbuechse reviewed Sep 12, 2023
View reviewed changes
Copy link
Contributor

@mbuechse mbuechse left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a few bits and pieces to be considered if you want to improve the text.

Benjamin Zapiec added 7 commits September 27, 2023 08:42
add a reference to the scs pipline definitions
757937e 
Signed-off-by: Benjamin Zapiec <zapiec@gonicus.de>
add new section for a basic example
a497f20 
Signed-off-by: Benjamin Zapiec <zapiec@gonicus.de>
add links to official documentation
4fcacdc 
Signed-off-by: Benjamin Zapiec <zapiec@gonicus.de>
add a hint for the special secrets handling within trusted and untrus…
2feb309 
…ted projects

Signed-off-by: Benjamin Zapiec <zapiec@gonicus.de>
mark zuul-client as optional and refer to secrets section
ebe425f 
Signed-off-by: Benjamin Zapiec <zapiec@gonicus.de>
spelling update
a0776c5 
Signed-off-by: Benjamin Zapiec <zapiec@gonicus.de>
spelling update
f99bd9d 
Signed-off-by: Benjamin Zapiec <zapiec@gonicus.de>
Benjamin Zapiec added 5 commits September 27, 2023 10:40
remove useless 'in'
bcd0b14 
Signed-off-by: Benjamin Zapiec <zapiec@gonicus.de>
update to satisfy linter
384af94 
Signed-off-by: Benjamin Zapiec <zapiec@gonicus.de>
convert zuul to Zuul if the name is referenced
9eb9e5f 
update some sp

Signed-off-by: Benjamin Zapiec <zapiec@gonicus.de>
add job nameing convention
afc36e4 
Signed-off-by: Benjamin Zapiec <zapiec@gonicus.de>
add a brief summary about the available piplines and their trigger
39d9f06 
events

Signed-off-by: Benjamin Zapiec <zapiec@gonicus.de>
@maxwolfs maxwolfs mentioned this pull request Sep 27, 2023
Merged
@fkr fkr self-requested a review September 27, 2023 14:07
fkr
fkr approved these changes Sep 27, 2023
View reviewed changes
Copy link
Member

@fkr fkr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. I'd like to see this being merged to then work in smaller chunks on it to further finetune it.

@master-caster master-caster mentioned this pull request Sep 28, 2023
Closed
8 tasks
@master-caster master-caster merged commit 7133b67 into main Sep 29, 2023
@master-caster master-caster deleted the zuulUserDoc branch September 29, 2023 07:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@fkr fkr fkr approved these changes

@mbuechse mbuechse mbuechse approved these changes

@matofeder matofeder matofeder left review comments

@osfrickler osfrickler osfrickler approved these changes

@maxwolfs maxwolfs Awaiting requested review from maxwolfs

@okautz okautz Awaiting requested review from okautz

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@master-caster @fkr @mbuechse @matofeder @osfrickler