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

Iox #482 rework installation manuals #630

Merged

Conversation

dkroenke
Copy link
Member

@dkroenke dkroenke commented Mar 23, 2021

Pre-Review Checklist for the PR Author

  1. Code follows the coding style of CONTRIBUTING.md
  2. Tests follow the best practice for testing
  3. Branch follows the naming format (iox-#123-this-is-a-branch)
  4. Commits messages are according to this guideline
    • Commit messages have the issue ID (iox-#123 commit text)
    • Commit messages are signed (git commit -s)
    • Commit author matches Eclipse Contributor Agreement (and ECA is signed)
  5. Update the PR title
    • Follow the same conventions as for commit messages
    • Link to the relevant issue
  6. Relevant issues are linked
  7. Add sensible notes for the reviewer
  8. All checks have passed (except task-list-completed)
  9. Assign PR to reviewer

Notes for Reviewer

Reworking the installation manuals as preparation for the 1.0 release.

Checklist for the PR Reviewer

  • Commits are properly organized and messages are according to the guideline
  • Code according to our coding style and naming conventions
  • Unit tests have been written for new behavior
  • Public API changes are documented via doxygen
  • Copyright owner are updated in the changed files
  • PR title describes the changes

Post-review Checklist for the PR Author

  1. All open points are addressed and tracked via issues

References

Signed-off-by: Dietrich Krönke <dietrich.kroenke@apex.ai>
Signed-off-by: Dietrich Krönke <dietrich.kroenke@apex.ai>
Signed-off-by: Dietrich Krönke <dietrich.kroenke@apex.ai>
Signed-off-by: Dietrich Krönke <dietrich.kroenke@apex.ai>
Signed-off-by: Dietrich Krönke <dietrich.kroenke@apex.ai>
@dkroenke dkroenke added the documentation Improvements or additions to documentation label Mar 23, 2021
@codecov
Copy link

codecov bot commented Mar 23, 2021

Codecov Report

Merging #630 (39bf683) into master (6037f52) will increase coverage by 0.05%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #630      +/-   ##
==========================================
+ Coverage   73.72%   73.77%   +0.05%     
==========================================
  Files         317      318       +1     
  Lines       11044    11063      +19     
  Branches     1946     1947       +1     
==========================================
+ Hits         8142     8162      +20     
+ Misses       2137     2135       -2     
- Partials      765      766       +1     
Flag Coverage Δ
unittests 73.73% <ø> (+0.05%) ⬆️
unittests_timing 31.71% <ø> (+0.11%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
...ils/include/iceoryx_utils/internal/cxx/smart_c.inl 87.50% <0.00%> (-1.57%) ⬇️
iceoryx_utils/source/posix_wrapper/timer.cpp 60.52% <0.00%> (-0.88%) ⬇️
...ude/iceoryx_posh/internal/popo/used_chunk_list.inl 98.14% <0.00%> (ø)
..._utils/source/posix_wrapper/unix_domain_socket.cpp 58.52% <0.00%> (+1.84%) ⬆️
...ude/iceoryx_posh/internal/popo/used_chunk_list.hpp 100.00% <0.00%> (+2.27%) ⬆️

@dkroenke dkroenke self-assigned this Mar 23, 2021
doc/website/advanced/configuration-guide.md Outdated Show resolved Hide resolved
doc/website/advanced/configuration-guide.md Outdated Show resolved Hide resolved
doc/website/advanced/configuration-guide.md Outdated Show resolved Hide resolved
doc/website/advanced/configuration-guide.md Outdated Show resolved Hide resolved
doc/website/getting-started/installation.md Outdated Show resolved Hide resolved
doc/website/getting-started/installation.md Outdated Show resolved Hide resolved
doc/website/getting-started/installation.md Outdated Show resolved Hide resolved
doc/website/getting-started/installation.md Outdated Show resolved Hide resolved
doc/website/getting-started/installation.md Outdated Show resolved Hide resolved
Copy link
Contributor

@FerdinandSpitzschnueffler FerdinandSpitzschnueffler left a comment

Choose a reason for hiding this comment

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

Looks good to me. Just some minor findings, mostly typos.

doc/website/advanced/configuration-guide.md Outdated Show resolved Hide resolved
doc/website/advanced/configuration-guide.md Outdated Show resolved Hide resolved
doc/website/advanced/configuration-guide.md Outdated Show resolved Hide resolved
doc/website/advanced/configuration-guide.md Outdated Show resolved Hide resolved
doc/website/advanced/configuration-guide.md Outdated Show resolved Hide resolved
doc/website/getting-started/installation.md Outdated Show resolved Hide resolved
doc/website/getting-started/installation.md Outdated Show resolved Hide resolved
doc/website/getting-started/installation.md Outdated Show resolved Hide resolved
doc/website/advanced/configuration-guide.md Outdated Show resolved Hide resolved
doc/website/advanced/configuration-guide.md Outdated Show resolved Hide resolved
doc/website/advanced/configuration-guide.md Outdated Show resolved Hide resolved
doc/website/advanced/configuration-guide.md Outdated Show resolved Hide resolved
doc/website/advanced/configuration-guide.md Show resolved Hide resolved
doc/website/getting-started/installation.md Show resolved Hide resolved
doc/website/getting-started/installation.md Outdated Show resolved Hide resolved
doc/website/getting-started/installation.md Outdated Show resolved Hide resolved
mkdocs.yml Show resolved Hide resolved
mkdocs.yml Show resolved Hide resolved
@dkroenke dkroenke marked this pull request as ready for review March 25, 2021 14:38
CONTRIBUTING.md Outdated Show resolved Hide resolved
doc/website/advanced/configuration-guide.md Show resolved Hide resolved
doc/website/advanced/configuration-guide.md Show resolved Hide resolved
doc/website/advanced/configuration-guide.md Show resolved Hide resolved
doc/website/getting-started/installation.md Outdated Show resolved Hide resolved
doc/website/getting-started/installation.md Outdated Show resolved Hide resolved
@dkroenke dkroenke force-pushed the iox-#482-rework-installation-manuals branch from 1e3c687 to c64bcf6 Compare March 26, 2021 13:37
Signed-off-by: Dietrich Krönke <dietrich.kroenke@apex.ai>
Signed-off-by: Dietrich Krönke <dietrich.kroenke@apex.ai>
Signed-off-by: Dietrich Krönke <dietrich.kroenke@apex.ai>
…lation guide

Signed-off-by: Dietrich Krönke <dietrich.kroenke@apex.ai>
Signed-off-by: Dietrich Krönke <dietrich.kroenke@apex.ai>
… Contributing.md

Signed-off-by: Dietrich Krönke <dietrich.kroenke@apex.ai>
@dkroenke dkroenke force-pushed the iox-#482-rework-installation-manuals branch from 002c5d5 to e4ab4b8 Compare March 27, 2021 15:55
mossmaurice
mossmaurice previously approved these changes Mar 27, 2021
Copy link
Contributor

@mossmaurice mossmaurice left a comment

Choose a reason for hiding this comment

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

LGTM

…guides

Signed-off-by: Dietrich Krönke <dietrich.kroenke@apex.ai>
mossmaurice
mossmaurice previously approved these changes Mar 27, 2021
…n-manuals

Signed-off-by: Dietrich Krönke <dietrich.kroenke@apex.ai>
mossmaurice
mossmaurice previously approved these changes Mar 29, 2021
…ing.md

Signed-off-by: Dietrich Krönke <dietrich.kroenke@apex.ai>
@dkroenke dkroenke merged commit 948d02a into eclipse-iceoryx:master Mar 29, 2021
@dkroenke dkroenke deleted the iox-#482-rework-installation-manuals branch March 29, 2021 15:18
marthtz pushed a commit to boschglobal/iceoryx that referenced this pull request May 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Extend documentation for 1.0 release and website
5 participants