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

Add TUTORIAL and FAQ in Sedna's Documentation #390

Open
Lj1ang opened this issue Jan 13, 2023 · 5 comments
Open

Add TUTORIAL and FAQ in Sedna's Documentation #390

Lj1ang opened this issue Jan 13, 2023 · 5 comments
Labels
kind/documentation Categorizes issue or PR as related to documentation.

Comments

@Lj1ang
Copy link
Contributor

Lj1ang commented Jan 13, 2023

What would you like to be documented:

  • TUTORIAL: instructs users to customize their own cases.
  • FAQ: records frequently asked questions and corresponding solutions.

Why is this needed:
At present, Sedna's documentation doesn't teach users how to use Sedna very well. INTRODUCTION part tells about how Sedna's features are developed and EXAMPLE part is about how to quickly run the examples provided in Sedna. Neither of the two parts instructs users to customize their own cases based on Sedna's API.

@Lj1ang Lj1ang added the kind/documentation Categorizes issue or PR as related to documentation. label Jan 13, 2023
@MooreZheng
Copy link

As mentioned, EXAMPLE part is about how to quickly run the examples provided in Sedna. It is important to have documents for further developing examples. /assign @luosiqi might help to follow up the issue.

@Lj1ang
Copy link
Contributor Author

Lj1ang commented Feb 3, 2023

/assign @luosiqi

@kubeedge-bot
Copy link
Collaborator

@Lj1ang: GitHub didn't allow me to assign the following users: luosiqi.

Note that only kubeedge members, repo collaborators and people who have commented on this issue/PR can be assigned. Additionally, issues/PRs can only have 10 assignees at the same time.
For more information please see the contributor guide

In response to this:

/assign @luosiqi

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@MooreZheng
Copy link

hi @luosiqi pls also follow up this issue

@MooreZheng
Copy link

MooreZheng commented Mar 31, 2023

We have wonderful contributors working on these issues.
@luosiqi #391 Proposal and tutorial of unstructured lifelong learning
@qxygxt #401 Tutorial for ATCII Lifelong Learning Job

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Categorizes issue or PR as related to documentation.
Projects
None yet
Development

No branches or pull requests

3 participants