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

DOCS: added UCC User User Guide #720

Merged
merged 4 commits into from
Mar 14, 2023
Merged

DOCS: added UCC User User Guide #720

merged 4 commits into from
Mar 14, 2023

Conversation

jirikraus
Copy link
Contributor

What

Proposal for a UCC End User, e.g. developers of MPI applications, Guide.

Why ?

Currently information about basic concepts like Team Layer, Collective Layer is scattered (FAQ, API Docs) and target for developers contributing to UCC or using UCC directly. Documentation for developers using UCC via e.g. an UCC enabled MPI stack is missing.

@swx-jenkins3
Copy link

Can one of the admins verify this patch?

@Sergei-Lebedev
Copy link
Contributor

ok to test

@Sergei-Lebedev
Copy link
Contributor

@jirikraus thanks for this PR! please change commit title to "DOCS: added UCC User User Guide" to make codestyle checker happy.

@jirikraus jirikraus force-pushed the ucc_userguide_proposal branch from a780d82 to a136e02 Compare January 30, 2023 08:20
@jirikraus jirikraus changed the title Added UCC User User Guide. DOCS: added UCC User User Guide Jan 30, 2023
@jirikraus
Copy link
Contributor Author

@jirikraus thanks for this PR! please change commit title to "DOCS: added UCC User User Guide" to make codestyle checker happy.

Thanks @Sergei-Lebedev for taking a look at this so quickly. Just updated the commit title.

@manjugv
Copy link
Contributor

manjugv commented Jan 31, 2023

@edgargabriel Can you please review?

edgargabriel
edgargabriel approved these changes Jan 31, 2023
View reviewed changes
Copy link
Contributor

@edgargabriel edgargabriel left a comment

Choose a reason for hiding this comment

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

I think the document looks very good and helpful. Just a few questions, please feel free to ignore.

One other item, do I recall correctly that there was also the possibility to use a configuration file instead of the environment variables? If yes, would it make sense to mention it here?

docs/user_guide.md Show resolved Hide resolved
docs/user_guide.md Show resolved Hide resolved
@jirikraus
Copy link
Contributor Author

jirikraus commented Feb 1, 2023 •
edited
Loading

One other item, do I recall correctly that there was also the possibility to use a configuration file instead of the environment variables? If yes, would it make sense to mention it here?

Yes I would like to add that. Where can I read up on how the file location is determined and what the format is? @edgargabriel can you comment on this and my other replies?

@jirikraus
Copy link
Contributor Author

Thanks @Sergei-Lebedev and @edgargabriel for your reviews. Except the open item on the configuration file for which I need input (@manjugv can you help?) I think I addressed all your comments. The specific open questions on that are:

  • How is the file configuration file location is determined?
  • What is the configuration file format?

@manjugv
Copy link
Contributor

manjugv commented Feb 1, 2023

Thanks @Sergei-Lebedev and @edgargabriel for your reviews. Except the open item on the configuration file for which I need input (@manjugv can you help?) I think I addressed all your comments. The specific open questions on that are:

@shimmybalsam is working updating the FAQ and wiki for this. Do you want to cross link later or do you want to wait for it to be added?

@jirikraus
Copy link
Contributor Author

Thanks @Sergei-Lebedev and @edgargabriel for your reviews. Except the open item on the configuration file for which I need input (@manjugv can you help?) I think I addressed all your comments. The specific open questions on that are:

@shimmybalsam is working updating the FAQ and wiki for this. Do you want to cross link later or do you want to wait for it to be added?

Either way works for me. What is the ETA for the FAQ und wiki updates?

@shimmybalsam
Copy link
Collaborator

Thanks @Sergei-Lebedev and @edgargabriel for your reviews. Except the open item on the configuration file for which I need input (@manjugv can you help?) I think I addressed all your comments. The specific open questions on that are:

@shimmybalsam is working updating the FAQ and wiki for this. Do you want to cross link later or do you want to wait for it to be added?

Either way works for me. What is the ETA for the FAQ und wiki updates?

FAQ and wiki update should be done during next week

@jirikraus
Copy link
Contributor Author

FAQ and wiki update should be done during next week

Then let's wait for it. @shimmybalsam can you ping me here when that is done?

@jirikraus jirikraus mentioned this pull request Feb 2, 2023
Merged
@shimmybalsam
Copy link
Collaborator

FAQ and wiki update should be done during next week

Then let's wait for it. @shimmybalsam can you ping me here when that is done?

Hi @jirikraus you can find the content of updated version (waiting to be approved and added into wiki by manju) in this issue i just opened: #726
Let me know if you have any further questions or comments.

@Sergei-Lebedev
Copy link
Contributor

hi @jirikraus, both PRs for config file and log improvement were merged

jirikraus
jirikraus commented Mar 7, 2023
View reviewed changes
docs/user_guide.md Outdated Show resolved Hide resolved
@jirikraus jirikraus requested review from manjugv and edgargabriel and removed request for vspetrov, bureddy, manjugv and edgargabriel March 7, 2023 16:37
@jirikraus jirikraus requested review from edgargabriel and manjugv and removed request for manjugv and edgargabriel March 7, 2023 16:38
@jirikraus jirikraus force-pushed the ucc_userguide_proposal branch from fe4ec09 to 720fc5f Compare March 9, 2023 21:40
@jirikraus jirikraus force-pushed the ucc_userguide_proposal branch 2 times, most recently from 50ca53e to 0489f22 Compare March 13, 2023 07:26
@jirikraus
DOCS: added UCC User User Guide
b49bb1d
@jirikraus
DOCS: UCC User Guide
d9b1937 
Adressed review comments from @adgargabriel.
@jirikraus jirikraus force-pushed the ucc_userguide_proposal branch from 0489f22 to e403cd8 Compare March 13, 2023 07:26
@jirikraus jirikraus force-pushed the ucc_userguide_proposal branch from e403cd8 to 319ac26 Compare March 13, 2023 08:08
@jirikraus
Copy link
Contributor Author

jirikraus commented Mar 14, 2023 •
edited
Loading

@manjugv can this be merged? The two checks that fail timed out so I doubt there is anything I can do about this.

@Sergei-Lebedev Sergei-Lebedev merged commit 301e5cb into openucx:master Mar 14, 2023
@Sergei-Lebedev
Copy link
Contributor

@manjugv can this be merged? The two checks that fail timed out so I doubt there is anything I can do about this.

merged, thanks @jirikraus

janjust pushed a commit to janjust/ucc that referenced this pull request Jan 31, 2024
@jirikraus @janjust
DOCS: added UCC User User Guide (openucx#720)
7c61f13 
* DOCS: added UCC User User Guide

* DOCS: UCC User Guide

Adressed review comments from @adgargabriel.

* DOCS: Added descr. of ucc.conf and UCC_COLL_TRACE

* DOCS: Added UCC version supporting UCC_COLL_TRACE
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@edgargabriel edgargabriel edgargabriel approved these changes

@Sergei-Lebedev Sergei-Lebedev Sergei-Lebedev approved these changes

@manjugv manjugv manjugv approved these changes

Assignees
No one assigned
Labels
Ready-for-Review
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@jirikraus @swx-jenkins3 @Sergei-Lebedev @manjugv @shimmybalsam @edgargabriel