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] align practical_guides/create_dataset.html with end2end examples structure #4275

Closed
davidberenstein1957 opened this issue Nov 20, 2023 · 1 comment
Closed

[DOCS] align practical_guides/create_dataset.html with end2end examples structure #4275

davidberenstein1957 opened this issue Nov 20, 2023 · 1 comment
Assignees
@sdiazlor
Labels
team: interns Indicates that the issue or pull request is owned by the machine learning interns team team: ml Indicates that the issue or pull request is owned by the Machine Learning (ML) team type: documentation Improvements or additions to documentation
Milestone
v1.21.0

Comments

@davidberenstein1957
Copy link
Member

davidberenstein1957 commented Nov 20, 2023 •
edited
Loading

https://user-images.githubusercontent.com/25269220/281716479-ee9ddb79-1ac4-4c51-90ea-053c05f51ef4.png

Which page or section is this issue related to?

I think it would be clearer to have separate sub-pages per dataset addition (suggestions/responses, metadata, vectors).

  • create and update a dataset
    • records
    • suggestions and responses
    • metadata
    • vectors
@davidberenstein1957 davidberenstein1957 added type: documentation Improvements or additions to documentation team: interns Indicates that the issue or pull request is owned by the machine learning interns team labels Nov 20, 2023
@davidberenstein1957 davidberenstein1957 added the team: ml Indicates that the issue or pull request is owned by the Machine Learning (ML) team label Nov 22, 2023
@davidberenstein1957 davidberenstein1957 self-assigned this Nov 27, 2023
@davidberenstein1957 davidberenstein1957 added this to the v1.20.0 milestone Nov 27, 2023
@davidberenstein1957 davidberenstein1957 modified the milestones: v1.20.0, v1.21.0 Nov 30, 2023
@davidberenstein1957
Copy link
Member Author

davidberenstein1957 commented Nov 30, 2023 •
edited
Loading

Also, feel free to add the workflow images, to each of the corresponding pages. For example, https://docs.argilla.io/en/latest/practical_guides/assign_records.html.

Additionally, we can add a reference to the linked end2end tutorials corresponding tot the practical guides

@davidberenstein1957 davidberenstein1957 modified the milestone: v1.21.0 Nov 30, 2023
@sdiazlor sdiazlor mentioned this issue Dec 5, 2023
Merged
9 tasks
davidberenstein1957 pushed a commit that referenced this issue Dec 7, 2023
@sdiazlor
docs: align practical guidescreate datasethtml with end2end examples …
d7b64ef 
…structure (#4375)

<!-- Thanks for your contribution! As part of our Community Growers
initiative 🌱, we're donating Justdiggit bunds in your name to reforest
sub-Saharan Africa. To claim your Community Growers certificate, please
contact David Berenstein in our Slack community or fill in this form
https://tally.so/r/n9XrxK once your PR has been merged. -->

# Description

align practical guides with end2end examples

Closes #4275

**Type of change**

(Remember to title the PR according to the type of change)

- [x] Documentation update

**How Has This Been Tested**

(Please describe the tests that you ran to verify your changes.)

- [x] `sphinx-autobuild` (read [Developer
Documentation](https://docs.argilla.io/en/latest/community/developer_docs.html#building-the-documentation)
for more details)

**Checklist**

- [ ] I added relevant documentation
- [ ] I followed the style guidelines of this project
- [ ] I did a self-review of my code
- [ ] I made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I filled out [the contributor form](https://tally.so/r/n9XrxK)
(see text above)
- [ ] I have added relevant notes to the `CHANGELOG.md` file (See
https://keepachangelog.com/)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sdiazlor sdiazlor

Labels
team: interns Indicates that the issue or pull request is owned by the machine learning interns team team: ml Indicates that the issue or pull request is owned by the Machine Learning (ML) team type: documentation Improvements or additions to documentation
Projects
None yet
Milestone
v1.21.0
Development

When branches are created from issues, their pull requests are automatically linked.

docs/4275-docs-align-practical_guidescreate_datasethtml-with-end2end-examples-structure argilla-io/argilla
2 participants
@davidberenstein1957 @sdiazlor