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

Tracking issues of services docs #2304

Closed
24 of 29 tasks
Xuanwo opened this issue May 24, 2023 · 7 comments
Closed
24 of 29 tasks

Tracking issues of services docs #2304

Xuanwo opened this issue May 24, 2023 · 7 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@Xuanwo
Copy link
Member

Xuanwo commented May 24, 2023 •
edited
Loading

PR #2285 introduces a new service doc that available for all language bindings. This tracking issue is used to track the progress of docs migration.

Please leave comments to take part in

Migration

  • Add docs.md under services
    • move all Builder's doc comments into markdown instead by #[doc = include_str!("docs.md")]
  • Add <service>.mdx under website/docs/services/<service>.mdx
    • include markdown by import Docs from '../../../core/src/services/<service>/docs.md'
    • Add Via Config for all langauges

Tasks
@Xuanwo Xuanwo added documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed labels May 24, 2023
@dqhl76
Copy link
Member

dqhl76 commented May 24, 2023

Please let me write some of these. May be azdfs cos dashmap? 🚀

@Xuanwo
Copy link
Member Author

Xuanwo commented May 24, 2023

Please let me write some of these. May be azdfs cos dashmap? 🚀

Thanks a lot! Have fun!

@dqhl76 dqhl76 mentioned this issue May 24, 2023
Merged
@A-Stupid-Sun
Copy link
Contributor

hey @Xuanwo , I'm new here, may I pick some task of these ? such as oss
BTW, I'am a big fan of you and Databend, would you like to tell me where can I find the roadmap of this project?

@Xuanwo
Copy link
Member Author

Xuanwo commented Jun 3, 2023

hey @Xuanwo , I'm new here, may I pick some task of these ? such as oss

Thanks a lot! I have assign that to you. Have fun!

BTW, I'am a big fan of you and Databend, would you like to tell me where can I find the roadmap of this project?

We have a roadmap of this year: #1301

But it's a bit outdated, I will update it next week.

@A-Stupid-Sun A-Stupid-Sun mentioned this issue Jun 3, 2023
Merged
@A-Stupid-Sun
Copy link
Contributor

could i migrate more services‘s docs？
@Xuanwo

@suyanhanx
Copy link
Member

could i migrate more services‘s docs？
@Xuanwo

😆Feel free to take tasks.

This was referenced Aug 25, 2023
Merged
Merged
@G-XD G-XD mentioned this issue Aug 31, 2023
Merged
@nasnoisaac nasnoisaac mentioned this issue Sep 10, 2023
Merged
@Xuanwo Xuanwo mentioned this issue Oct 16, 2023
Closed
10 tasks
@Xuanwo
Copy link
Member Author

Xuanwo commented Nov 20, 2023

Mostly DONE, let's close.

@Xuanwo Xuanwo closed this as completed Nov 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@Xuanwo @suyanhanx @A-Stupid-Sun @dqhl76