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

Expand config parameter location explanation #2518

Merged
merged 4 commits into from
Mar 10, 2021

Conversation

M-Davies
Copy link
Contributor

@M-Davies M-Davies commented Mar 5, 2021

Signed-off-by: Morgan Davies morgandavies2020@gmail.com

* Further explains how and where shell script parameters should be injected
* Follow on from adoptium#2506
* Part 2 of adoptium#2129

Signed-off-by: Morgan Davies <morgandavies2020@gmail.com>
@M-Davies M-Davies added enhancement Issues that enhance the code or documentation of the repo in any way documentation Issues that request updates to our documentation labels Mar 5, 2021
@M-Davies M-Davies added this to the March 2021 milestone Mar 5, 2021
@M-Davies M-Davies requested a review from sxa March 5, 2021 00:08
Copy link
Member

@sxa sxa left a comment

Choose a reason for hiding this comment

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

This superficially looks like a good set of recommendations, but I'll hold off on approving until Monday as I'm quite tired just now. I do think it's something that most of the build team shoul dhave input to so might be good to circulate in #build for wider review and opinions, but this will be a great addition to the documentation so thanks for kicking it off!

Copy link
Contributor

@karianna karianna left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Member

@sxa sxa left a comment

Choose a reason for hiding this comment

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

I'm not a fan of "jenkins machine style environment" as that's a bit vague. I'd suggest that the intention was to reference machines in the jenkins farm which were set up by ansible specifically so I'd recommend different wording explicitly pointing to the infra repo as per my suggested change.

Is it also worth including the table from #2129 (comment) about when each parameter takes effect as that may not be clear to new users.

We possibly have another piece of work to do to ensure that all variables are set in the "right" place according to these guidelines but this is a good start and we badly need this sort of guidance :-)

FAQ.md Outdated Show resolved Hide resolved
Morgan Davies and others added 2 commits March 8, 2021 12:02
Co-authored-by: Stewart X Addison <6487691+sxa@users.noreply.github.com>
Co-authored-by: Stewart X Addison <6487691+sxa@users.noreply.github.com>
@M-Davies M-Davies requested a review from sxa March 8, 2021 12:11
Copy link
Member

@sxa sxa left a comment

Choose a reason for hiding this comment

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

👍

@M-Davies M-Davies merged commit 8b51068 into adoptium:master Mar 10, 2021
@M-Davies M-Davies deleted the faq_upgrade branch April 30, 2021 12:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issues that request updates to our documentation enhancement Issues that enhance the code or documentation of the repo in any way
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants