feedback: Начало знакомства
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Product: Tarantool
Root document: https://www.tarantool.io/en/doc/2.11/getting_started/getting_started_imcp/#setting-up-http-api-2-minutes
SME: @ artur-barsegyan
Details
<…>ommand below with the corresponding UUIDs:
curl -X POST --data "|video_id=|...&user_id=..." url/like_videoПолучится примерно вот так:
<…>
https://www.tarantool.io/ru/doc/2.11/getting_started/getting_started_imcp/
There are no directions on how to actually upload a video. Therefore, it is not possible to like it since there is no video_id.
ToDo
Actually, the video_id is there: we get it from the previous request, namely,
curl -X POST --data "description=My first tiktok" url/add_video
Perhaps, the description is not clear.
ToDo:
- Create a subsection specifically for sending requests
- Update the description to make it more clear what IDs the reader is getting and when
- Translate the updated content
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the English and Russian root documents linked in the issue, especially the add_video and like_video request examples. Clarify where video_id and user_id come from, add the requested subsection for sending requests, and translate the updated content; done means the flow can be followed through liking a video.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100