Skip to content

Create Top Level Docs Dir #12

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

Merged
merged 2 commits into from
Sep 14, 2017
Merged

Create Top Level Docs Dir #12

merged 2 commits into from
Sep 14, 2017

Conversation

mgaudet
Copy link
Contributor

@mgaudet mgaudet commented Sep 14, 2017

To provide a home for various documentation about the project, this PR creates a top level docs dir.

Populate with the contents of the TRJ9 docs directory.

[ci skip] as it's a documentation change.

Signed-off-by: Matthew Gaudet <[email protected]>
Copy link
Contributor

@mstoodle mstoodle left a comment

Choose a reason for hiding this comment

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

otherwise LGTM, though maybe a few more couple more components could be listed in the main README.md file.

@@ -0,0 +1,11 @@
Documentation
Copy link
Contributor

Choose a reason for hiding this comment

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

This file should have a copyright header (yeah, I know...but documentation counts too!)

doc/README.md Outdated
Testarossa.

Much documentation about OpenJ9 is best considered in tandem with the
documentation from [Eclipse OMR](https://github.com/eclipse/omr/tree/master/doc),
Copy link
Contributor

Choose a reason for hiding this comment

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

maybe "documentation about" should be in the square brackets too, since the link goes to the doc, not the project

@mgaudet
Copy link
Contributor Author

mgaudet commented Sep 14, 2017

I only listed the components that had docs there -- and a cursory search of the repo didn't point at any directories to relocate.

* Improve console readability by wrapping lines
* Correct MarkDown rendering by marking various pieces with backticks.

[ci skip] Documentation reformatting change

Signed-off-by: Matthew Gaudet <[email protected]>
@mgaudet
Copy link
Contributor Author

mgaudet commented Sep 14, 2017

Fixed copyright header and doc link.

@mstoodle mstoodle merged commit cea1ed7 into eclipse-openj9:master Sep 14, 2017
tajila pushed a commit to tajila/openj9 that referenced this pull request Jun 21, 2019
* Updated header read/write & Updated code to follow OMR coding standard

* Fixed a couple formatting issues

Signed-off-by: Brady Jessup<[email protected]>
tajila pushed a commit to tajila/openj9 that referenced this pull request Jun 21, 2019
* Updated header read/write & Updated code to follow OMR coding standard

* Fixed a couple formatting issues

Signed-off-by: Brady Jessup<[email protected]>
hzongaro pushed a commit to hzongaro/openj9 that referenced this pull request Mar 24, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants