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.

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

Enhancements and fixes to documentation #2584

Closed
wants to merge 15 commits into from
Closed

Enhancements and fixes to documentation #2584

wants to merge 15 commits into from

Conversation

ljessicc
Copy link

@ljessicc ljessicc commented Apr 16, 2021 •
edited
Loading

Please preview the changed/updated page/image links, and other miscellaneous changes to the doc/ files

@M-Davies M-Davies linked an issue Apr 16, 2021 that may be closed by this pull request
Miscellaneous Minor Doc Enhancements and Fixes #2557
Closed
10 tasks
@M-Davies M-Davies added documentation Issues that request updates to our documentation enhancement Issues that enhance the code or documentation of the repo in any way labels Apr 16, 2021
@M-Davies M-Davies added this to the April 2021 milestone Apr 16, 2021
karianna
karianna requested changes Apr 18, 2021
View reviewed changes
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.

Didn't cover all of it, but a little more fine-tuning required :-)

md-docs/CONTRIBUTING.md Outdated Show resolved Hide resolved
md-docs/FAQ.md Outdated Show resolved Hide resolved
md-docs/README.md Outdated Show resolved Hide resolved
md-docs/README.md Outdated Show resolved Hide resolved
md-docs/README.md Outdated Show resolved Hide resolved
md-docs/README.md Outdated Show resolved Hide resolved
md-docs/README.md Outdated Show resolved Hide resolved
md-docs/README.md Outdated Show resolved Hide resolved
@karianna
Copy link
Contributor

Also, can you please edit this title with a description of the change :-)

M-Davies
M-Davies requested changes Apr 18, 2021
View reviewed changes
Copy link

@M-Davies M-Davies left a comment

Choose a reason for hiding this comment

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

Great start. Got a few points of my own.

  • Could probably just called the md-docs folder docs/ as it's generally more obvious that the folder contains docs that way
  • See below

md-docs/FAQ.md Outdated Show resolved Hide resolved
md-docs/RELEASING.md Outdated Show resolved Hide resolved
md-docs/RELEASING.md Outdated Show resolved Hide resolved
@ljessicc
Copy link
Author

Alright I will work on these. Thanks @karianna

@ljessicc
Copy link
Author

could please review the updated changes as per previous reviews? Renamed md-docs to docs/, replaced and updated deleted links

@smlambert smlambert changed the title Jessy lj Enhancements and fixes to documentation Apr 20, 2021
M-Davies
M-Davies requested changes Apr 20, 2021
View reviewed changes
Copy link

@M-Davies M-Davies left a comment

Choose a reason for hiding this comment

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

One final comment (sorry I missed this in my original review) and then LGTM

docs/FAQ.md Outdated Show resolved Hide resolved
M-Davies
M-Davies requested changes Apr 21, 2021
View reviewed changes
docs/CHANGELOG.md Outdated Show resolved Hide resolved
@ljessicc
Copy link
Author

ljessicc commented Apr 21, 2021 •
edited
Loading

I did my final commits after correcting generated lint code errors. If there's anything else required, I'd be glad to work on it.

@ljessicc ljessicc requested a review from karianna April 23, 2021 18:09
@ljessicc
Copy link
Author

please review and merge changes if ok. Thank you

@ljessicc
Updated all references of support url github.com/AdoptOpenJDK/openjdk…
944d83f 
…-support to github.com/adoptium/adoptium-support
@M-Davies M-Davies mentioned this pull request Apr 26, 2021
Closed
10 tasks
@M-Davies M-Davies linked an issue Apr 26, 2021 that may be closed by this pull request
Update all references of support url github.com/AdoptOpenJDK/openjdk-support to github.com/adoptium/adoptium-support #2590
Closed
10 tasks
@karianna karianna requested a review from M-Davies April 28, 2021 12:47
@karianna
Copy link
Contributor

You have a merge conflict

@ljessicc
Copy link
Author

@karianna ok, looking into it. Thank you

@karianna karianna modified the milestones: April 2021, May 2021 May 18, 2021
@karianna
Copy link
Contributor

@ljessicc looks like merge conflicts still sorry :-(

@karianna karianna modified the milestones: May 2021, June 2021 Jun 6, 2021
sxa
sxa reviewed Jul 12, 2021
View reviewed changes
Copy link
Member

@sxa sxa left a comment •
edited
Loading

Choose a reason for hiding this comment

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

I'm not convinced by the moving of the .md files at the top level - some of those are too much of a standard convention. I think README.md CONTRIBUTING.md and FAQ.md should definitely stay at the top level of the project.

@karianna
Copy link
Contributor

This has been superseded - thanks for your submission!

@karianna karianna closed this Sep 10, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sxa sxa sxa left review comments

@karianna karianna Awaiting requested review from karianna

@M-Davies M-Davies Awaiting requested review from M-Davies

Assignees
No one assigned
Labels
documentation Issues that request updates to our documentation enhancement Issues that enhance the code or documentation of the repo in any way security
Projects
None yet
Milestone
June 2021
4 participants
@ljessicc @karianna @sxa @M-Davies