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

chore(docs): Add doc for task outputs permissions #369

Merged
merged 2 commits into from
Oct 10, 2023

Conversation

Milouu
Copy link
Contributor

@Milouu Milouu commented Oct 2, 2023

Add some docs on the default permissions settings for FedAvg and what the user can see in the front with/without permissions.

Closes FL-1174

@linear
Copy link

linear bot commented Oct 2, 2023

FL-1174 Explain task outputs permissions in the docs

Context

Permission task outputs is not a well understood concept so we need to document it.

Specification

Acceptance criteria

Task outputs permissions concept is understandable by a new user.

Copy link
Member

@ThibaultFy ThibaultFy left a comment

Choose a reason for hiding this comment

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

Thx for the PR :)
Some comments about the form.
Plz update the changelog too

docs/source/substrafl_doc/substrafl_overview.rst Outdated Show resolved Hide resolved
docs/source/substrafl_doc/substrafl_overview.rst Outdated Show resolved Hide resolved
docs/source/substrafl_doc/substrafl_overview.rst Outdated Show resolved Hide resolved
docs/source/substrafl_doc/substrafl_overview.rst Outdated Show resolved Hide resolved
docs/source/substrafl_doc/substrafl_overview.rst Outdated Show resolved Hide resolved
docs/source/substrafl_doc/substrafl_overview.rst Outdated Show resolved Hide resolved
docs/source/substrafl_doc/substrafl_overview.rst Outdated Show resolved Hide resolved
docs/source/documentation/concepts.rst Outdated Show resolved Hide resolved
docs/source/documentation/concepts.rst Outdated Show resolved Hide resolved
docs/source/documentation/concepts.rst Outdated Show resolved Hide resolved
Signed-off-by: Milouu <milan.roustan@owkin.com>
@Milouu Milouu force-pushed the chore(docs)/task-outputs-permissions branch from 45a2caf to 0c3d28f Compare October 9, 2023 15:04
@Milouu Milouu requested a review from ThibaultFy October 9, 2023 15:11
@Milouu Milouu force-pushed the chore(docs)/task-outputs-permissions branch from 2ed9036 to d6e457a Compare October 9, 2023 15:13
Signed-off-by: Milouu <milan.roustan@owkin.com>
@Milouu Milouu force-pushed the chore(docs)/task-outputs-permissions branch from d6e457a to 9165b63 Compare October 10, 2023 08:43
Copy link
Member

@ThibaultFy ThibaultFy left a comment

Choose a reason for hiding this comment

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

LGTM ! :)

@Milouu Milouu merged commit 3a528c2 into main Oct 10, 2023
3 checks passed
@Milouu Milouu deleted the chore(docs)/task-outputs-permissions branch October 10, 2023 09:33
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.

2 participants