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

docs: refactor-docs-structure #5084

Merged
merged 3 commits into from
Feb 1, 2024

Conversation

nisiyong
Copy link
Member

@nisiyong nisiyong commented Jan 29, 2024

What's the purpose of this PR

Make the document structure more clear. The summary is as follows:

  • Add 4 sections: SDK Guide, Admin Guide(Portal), Extension Guide(Portal Extension), Contributor Guide.
  • Remove 2 sections: Development, and Usage.
  • Each language SDK has one single document.

Follow this checklist to help us incorporate your contribution quickly and easily:

  • Read the Contributing Guide before making this pull request.
  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.

@dosubot dosubot bot added the size:L This PR changes 100-499 lines, ignoring generated files. label Jan 29, 2024
docs/zh/_sidebar.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
docs/en/README.md Outdated Show resolved Hide resolved
docs/en/_sidebar.md Outdated Show resolved Hide resolved
docs/en/README.md Outdated Show resolved Hide resolved
Copy link

codecov bot commented Jan 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (73b4b84) 49.59% compared to head (aea6f48) 49.65%.

Additional details and impacted files
@@             Coverage Diff              @@
##             master    #5084      +/-   ##
============================================
+ Coverage     49.59%   49.65%   +0.06%     
- Complexity     1907     1908       +1     
============================================
  Files           372      372              
  Lines         11564    11564              
  Branches       1127     1127              
============================================
+ Hits           5735     5742       +7     
+ Misses         5486     5479       -7     
  Partials        343      343              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

docs/en/README.md Outdated Show resolved Hide resolved
docs/zh/README.md Outdated Show resolved Hide resolved
docs/zh/client/other-language-client-user-guide.md Outdated Show resolved Hide resolved
@dosubot dosubot bot added size:XL This PR changes 500-999 lines, ignoring generated files. and removed size:L This PR changes 100-499 lines, ignoring generated files. labels Jan 31, 2024
Copy link
Member

@nobodyiam nobodyiam left a comment

Choose a reason for hiding this comment

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

LGTM

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Feb 1, 2024
@nobodyiam nobodyiam merged commit e8d8ae1 into apolloconfig:master Feb 1, 2024
12 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Feb 1, 2024
@nisiyong nisiyong deleted the refactor-docs-structure branch February 1, 2024 05:06
@nobodyiam nobodyiam added this to the 2.3.0 milestone Apr 3, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
lgtm This PR has been approved by a maintainer size:XL This PR changes 500-999 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants