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

Issue-130: Align OH / IEAM docs #220

Merged
merged 62 commits into from
Mar 22, 2022
Merged

Issue-130: Align OH / IEAM docs #220

merged 62 commits into from
Mar 22, 2022

Conversation

johnwalicki
Copy link
Member

@johnwalicki johnwalicki commented Mar 17, 2022

Description

This PR attempts to synchronize as much of the Open Horizon / IEAM production documentation as possible.
Merges were done in both directions. Last Updated fields were synced.

Each modified markdown file is in a separate commit. That way we can discuss, reject, modify any changes I've proposed, individually. I won't have to drag along all the other modifications.
This will also prevent a massive merge conflict when the PR is accepted. (Smaller merge conflicts may occur and will be easier to resolve)

Fixes #130

Type of change

  • [x ] This change requires a documentation update

How Has This Been Tested?

I wrote a edge-doc-compare.sh bash script which scanned across both cloned repos.
Compared the .md files and, if there were differences, loaded them into meld (a file merge/compare tool available on Linux)
I inspected the files and synchronized as much as possible.

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation
  • I have checked my code and corrected any misspellings
  • I have tagged the reviewers in a comment below incase my pull request is ready for a review
  • I have signed the commit message to agree to Developer Certificate of Origin (DCO) (to certify that you wrote or otherwise have the right to submit your contribution to the project.) by adding "--signoff" to my git commit command.

Signed-off-by: John Walicki <[email protected]>
Signed-off-by: John Walicki <[email protected]>
Signed-off-by: John Walicki <[email protected]>
Signed-off-by: John Walicki <[email protected]>
@joewxboy joewxboy changed the title Isssue 130: Align OH / IEAM docs Issue 130: Align OH / IEAM docs Mar 18, 2022
@joewxboy joewxboy changed the title Issue 130: Align OH / IEAM docs Issue-130: Align OH / IEAM docs Mar 18, 2022
Copy link
Member

@joewxboy joewxboy left a comment

Choose a reason for hiding this comment

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

See all my inline comments. Some may be out of scope for this effort and thus may need to be converted into separate issues. Others require the input of a SME like Booz or Potter.

Signed-off-by: John Walicki <[email protected]>
Signed-off-by: John Walicki <[email protected]>
@Abhijay007
Copy link
Contributor

Too many commits for a single PR 😅 @johnwalicki can you please stash these commits into a single commit?

@johnwalicki
Copy link
Member Author

I'm a strong believer in small, bite size commits which fix one thing. Each commit in this PR is one file worth of merges between the OH/IEAM documentation. There are 55+ files changed, so, close to 60 commits. A jumbo PR would be indigestible.

@Abhijay007
Copy link
Contributor

I'm a strong believer in small, bite size commits which fix one thing. Each commit in this PR is one file worth of merges between the OH/IEAM documentation. There are 55+ files changed, so, close to 60 commits. A jumbo PR would be indigestible.

got it :)

@Abhijay007 Abhijay007 requested a review from joewxboy March 21, 2022 17:52
@joewxboy
Copy link
Member

It looks like we only have three comments left to resolve

@johnwalicki
Copy link
Member Author

@joewxboy - Thanks for the comments/suggestions. I've done some minor fix ups and punted others to track in separate issues. Not perfect but definitely highlights where the docs need more work. I recommend we merge this monster boulder and chip away at the smaller rocks.

@johnwalicki johnwalicki dismissed joewxboy’s stale review March 22, 2022 01:48

Some recommended changes have been incorporated. Some have been punted to new issues for further discussion / effort.

Copy link
Member

@joewxboy joewxboy left a comment

Choose a reason for hiding this comment

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

Looks like all the comments are resolved.

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.

Align OH files with updated IEAM files
3 participants