👾 Description of the issue
After the effort to split openjdk-build into two, we find ourselves with some documentation that is out of date, jumbled or outright wrong in some places. This issue intends to amend these irregularities by tidying up the visual features of this repo. Some ideas:
.md files at the root of this repo that could be moved into their own directory (called docs/ maybe?). NOTE: SECURITY.md and LICENSE would need to stay as they are special files that GitHub needs to have at the repository root.make-adopt-build-farm.sh script is a G script, not a S script📋 Step by Step
To solve this issue and contribute a fix you should check the following step-by-step list. A more detailed documentation of the workflow can be found here.
🤔❓ Questions
If you have any questions just ask us directly in this issue by adding a comment. You can join our community chat at Slack. Next to this you can find a general manual about open source contributions here.
Hi, I am Jessica and I'm new to contributing on projects. I'm currently looking for a first good issue to start contributing and this seems like it could be a good one. I would like to give it a go. Thank you
Welcome @ljessicc ! It is now assigned to you, if you have any questions, please feel free to ask them in this issue.
Very well. Thank you
Are the images mentioned in the README.md, the links referring to [slack], [DockerFileCheck]? I have tried finding valid updated links to replace these but I haven't been able to. Should I only delete the links or the whole paragraphs pointing to them?
Actually I just noticed many of the links in the FAQ.md are invalid
Are the images mentioned in the README.md, the links referring to [slack], [DockerFileCheck]? I have tried finding valid updated links to replace these but I haven't been able to. Should I only delete the links or the whole paragraphs pointing to them?
DockerFileCheck can probably be deleted, I don't think that job exists anymore after the rejig of the docker pipelines a while back. The image icon url for slack can probably be replaced by any generic one found on google. As for the actual link that the icon will take you too, it is possible to copy a link to a channel in slack by right clicking on the channel. Maybe we could replace the https://slackin-jmnmplfpdu.now.sh/ part with whatever that link may be?
Ok. Thanks
I am done with my changes, please review
Most helpful comment
Hi, I am Jessica and I'm new to contributing on projects. I'm currently looking for a first good issue to start contributing and this seems like it could be a good one. I would like to give it a go. Thank you