Skip to content
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.

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

Separate configured params to new asciidoc #211

Merged
merged 2 commits into from Sep 1, 2022

Conversation

vihaanthora
Copy link
Contributor

Addresses the problem associated with #203
Added a line to create the new folder in allAscii.zip. Rest everything remains the same.

@MarkEWaite kindly review this and let me know if it gets a green flag. I'll also test the allAscii.zip generated from this build against the make script of jenkins.io.

@vihaanthora
Copy link
Contributor Author

I can confirm that the AsciiDoc within the new allAscii.zip contains the expected content now.

Copy link
Contributor

@MarkEWaite MarkEWaite left a comment

Choose a reason for hiding this comment

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

This looks good to me, though I've not run a test to confirm it is well-behaved.

Is there a reasonable way for me to perform an end to end test on my development machine before it is merged?

README.md Outdated Show resolved Hide resolved
Co-authored-by: Mark Waite <mark.earl.waite@gmail.com>
@vihaanthora
Copy link
Contributor Author

Is there a reasonable way for me to perform an end to end test on my development machine before it is merged?

I can describe the way that I tested it. I downloaded the allAscii.zip file and unzipped it in the pipeline/steps/ folder of jenkins.io. Then I commented that particular information from being fetched as an external resource, and run make all. Any inconsistency in the syntax of asciidocs would have been caught here (like the error present in the previous PR). To test if the generated documentation is exhaustive of all the existing documentation, I searched the original documentation for the configured class names to ensure that they follow all the rules mentioned in the README. I tested the links by going to Pipeline: Multibranch > resolveScm > fromScm > scm > MultiSCM > GitSCM.

I can explain some interesting parameters included in config.txt in the next docs office hours, and also discuss what else can be configured to lighten the site up the furthermore.

@MarkEWaite
Copy link
Contributor

I can describe the way that I tested it.

That was a great description. Thanks!

I'm about to go offline for the rest of the day. If you're available to check the build results over the course of the next several hours, I could merge this and then after this is built and the allAscii.zip is available, I could merge a jenkins.io pull request to cause the build to run. However, I won't be able to take action if it fails.

Considering how late it is in your time zone, I think we should wait for the merge until tomorrow. What's your preference @vihaanthora ?

@vihaanthora
Copy link
Contributor Author

vihaanthora commented Aug 31, 2022

Yes @MarkEWaite, I think we should take it forward tomorrow, and we can also use the docs office hours to facilitate the merge process if required.

@MarkEWaite MarkEWaite merged commit 660aaff into jenkins-infra:master Sep 1, 2022
@vihaanthora vihaanthora deleted the shift-params branch September 2, 2022 06:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants