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 #743 Fix website generation and typos #746

Merged

Conversation

mossmaurice
Copy link
Contributor

@mossmaurice mossmaurice commented Apr 19, 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

  • Fix include issue with MkDocs
  • Fix typos
  • Update to mike v1.0.0 to avoid HTML duplication
  • Fix links to methods in doxygen docu

These changes will be backported to release_1.0 with the next v1.x 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: Simon Hoinkis <simon.hoinkis@apex.ai>
Signed-off-by: Simon Hoinkis <simon.hoinkis@apex.ai>
Signed-off-by: Simon Hoinkis <simon.hoinkis@apex.ai>
@mossmaurice mossmaurice added the documentation Improvements or additions to documentation label Apr 19, 2021
@mossmaurice mossmaurice self-assigned this Apr 19, 2021
@codecov
Copy link

codecov bot commented Apr 19, 2021

Codecov Report

Merging #746 (85c495f) into master (4ce5310) will decrease coverage by 0.08%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #746      +/-   ##
==========================================
- Coverage   74.03%   73.94%   -0.09%     
==========================================
  Files         319      319              
  Lines       11426    11454      +28     
  Branches     1972     1976       +4     
==========================================
+ Hits         8459     8470      +11     
- Misses       2192     2206      +14     
- Partials      775      778       +3     
Flag Coverage Δ
unittests 72.76% <ø> (-0.06%) ⬇️
unittests_timing 30.42% <ø> (-0.08%) ⬇️

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

Impacted Files Coverage Δ
...oryx_posh/source/runtime/ipc_runtime_interface.cpp 53.50% <0.00%> (-7.90%) ⬇️
...e/iceoryx_utils/internal/concurrent/smart_lock.inl 92.45% <0.00%> (-7.55%) ⬇️
..._utils/source/posix_wrapper/unix_domain_socket.cpp 57.07% <0.00%> (-1.83%) ⬇️
...nternal/roudi/introspection/port_introspection.inl 71.89% <0.00%> (-0.73%) ⬇️
iceoryx_posh/source/roudi/roudi.cpp 54.28% <0.00%> (ø)
...e/iceoryx_utils/internal/concurrent/smart_lock.hpp 100.00% <0.00%> (ø)
iceoryx_utils/source/posix_wrapper/file_lock.cpp 30.57% <0.00%> (+0.82%) ⬆️
...ils/include/iceoryx_utils/internal/cxx/smart_c.inl 90.62% <0.00%> (+1.56%) ⬆️

@mossmaurice mossmaurice linked an issue Apr 19, 2021 that may be closed by this pull request
53 tasks
doc/website/advanced/iceoryx_utils.md Show resolved Hide resolved
@@ -8,9 +8,9 @@ title: Home
width="50%">
</p>

Eclipse iceoryx™ is an inter-process-communication midddleware that enables virtually limitless data transmissions at constant time.
Eclipse iceoryx™ is an inter-process-communication middleware that enables virtually limitless data transmissions at constant time.
Copy link
Contributor

Choose a reason for hiding this comment

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

Ouh ... only two d's I thought the third d was to there to praise hypnotoad

dkroenke
dkroenke previously approved these changes Apr 19, 2021
…n links, update mike, add sanity check for path and fix broken link in utils readme

Signed-off-by: Simon Hoinkis <simon.hoinkis@apex.ai>
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.

Improve documentation and website for v2.0
4 participants