Skip to content

docs: Style guide for APISIX documentation#974

Merged
yzeng25 merged 4 commits into
apache:masterfrom
pottekkat:docs/style-guide/6672
Mar 30, 2022
Merged

docs: Style guide for APISIX documentation#974
yzeng25 merged 4 commits into
apache:masterfrom
pottekkat:docs/style-guide/6672

Conversation

@pottekkat

@pottekkat pottekkat commented Mar 28, 2022

Copy link
Copy Markdown
Member

Fixes apache/apisix#6672

Changes:

  • Adds a style guide for APISIX documentation.
  • Reorganises the Community tab by consolidating and organising different docs.
  • Updates the links to the changed pages.

@pottekkat
docs: Update community docs
b50efae 
Signed-off-by: Navendu Pottekkat <[email protected]>
@pottekkat
docs: add style guide
45b1db7 
Signed-off-by: Navendu Pottekkat <[email protected]>
@netlify

netlify Bot commented Mar 28, 2022 •
edited
Loading

Copy link
Copy Markdown

✅ Deploy Preview for apache-apisix ready!

Name Link
🔨 Latest commit 7812e99
🔍 Latest deploy log https://app.netlify.com/sites/apache-apisix/deploys/6241b33c2db3f40008e2c0cf
😎 Deploy Preview https://deploy-preview-974--apache-apisix.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@pottekkat

pottekkat commented Mar 28, 2022

Copy link
Copy Markdown
Member Author

@juzhiyuan @yzeng25 @avinal @hf400159 Could you please review this PR? I will fix the lint errors.

@pottekkat
docs: fix lint error
976173b 
Signed-off-by: Navendu Pottekkat <[email protected]>
@pottekkat pottekkat mentioned this pull request Mar 28, 2022
Closed
leslie-tsang
leslie-tsang approved these changes Mar 28, 2022
View reviewed changes

@leslie-tsang leslie-tsang left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

okaybase
okaybase previously approved these changes Mar 28, 2022
View reviewed changes
juzhiyuan
juzhiyuan reviewed Mar 28, 2022
View reviewed changes
Comment thread README.md
@leslie-tsang
leslie-tsang self-requested a review March 28, 2022 07:21
juzhiyuan
juzhiyuan reviewed Mar 28, 2022
View reviewed changes
Comment thread website/docs/general/join.md Outdated
Comment thread website/docs/general/join.md Outdated
Comment thread website/docs/general/2fa.md
leslie-tsang
leslie-tsang previously requested changes Mar 28, 2022
View reviewed changes
Comment thread website/blog/2021/06/28/why-we-need-Apache-APISIX.md Outdated
juzhiyuan
juzhiyuan reviewed Mar 28, 2022
View reviewed changes
Comment thread website/docs/general/committer-guide.md Outdated
Comment thread website/docs/general/documentation-guide.md Outdated
Comment thread website/docs/general/documentation-guide.md
Comment thread website/docs/general/documentation-guide.md Outdated
@leslie-tsang
leslie-tsang dismissed their stale review March 28, 2022 07:58

need double check

@juzhiyuan

juzhiyuan commented Mar 28, 2022

Copy link
Copy Markdown
Member

Link to one discussion: facebook/docusaurus#5838 (comment)

yzeng25
yzeng25 reviewed Mar 28, 2022
View reviewed changes
Comment thread website/docs/general/join.md Outdated
Comment thread website/docs/general/join.md Outdated
Comment thread website/docs/general/join.md Outdated
Comment thread website/docs/general/documentation-guide.md
Comment thread website/docs/general/documentation-guide.md
Comment thread website/docs/general/contributor-guide.md
Comment thread website/docs/general/contributor-guide.md
Comment thread website/docs/general/sidebars.json Outdated
Comment thread website/docs/general/contributor-guide.md
Comment thread website/docs/general/contributor-guide.md
avinal
avinal reviewed Mar 28, 2022
View reviewed changes
Comment thread website/blog/2021/12/01/apisix-supports-azure-functions.md Outdated
avinal
avinal reviewed Mar 28, 2022
View reviewed changes
Comment thread website/docs/general/documentation-guide.md
@pottekkat
docs: apply suggestions from review
7812e99 
Signed-off-by: Navendu Pottekkat <[email protected]>
@pottekkat

pottekkat commented Mar 28, 2022 •
edited
Loading

Copy link
Copy Markdown
Member Author

I have left comments and made changes as suggested please check.

I'm having trouble configuring the redirect plugin: #974 (comment)

// @juzhiyuan

@pottekkat

pottekkat commented Mar 28, 2022

Copy link
Copy Markdown
Member Author

I have left comments and made changes as suggested please check.

I'm having trouble configuring the redirect plugin: #974 (comment)

// @juzhiyuan

I think this maybe because we are still using an older version of Docusaurus and bumping it up might fix it. But I'm not sure if that is desired or it may break anything.

@juzhiyuan

juzhiyuan commented Mar 29, 2022

Copy link
Copy Markdown
Member

Don't worry, see #974 (comment)

@juzhiyuan

juzhiyuan commented Mar 29, 2022

Copy link
Copy Markdown
Member

Hi reviewers, please first review website/docs/general/documentation-guide.md, thanks!

@pottekkat

pottekkat commented Mar 29, 2022

Copy link
Copy Markdown
Member Author

Here is the link to the documentation style guide proposed in this PR: https://deploy-preview-974--apache-apisix.netlify.app/docs/general/documentation-style-guide

yzeng25
yzeng25 reviewed Mar 29, 2022
View reviewed changes

@yzeng25 yzeng25 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

lilien1010
lilien1010 approved these changes Mar 29, 2022
View reviewed changes

@lilien1010 lilien1010 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

shuaijinchao
shuaijinchao approved these changes Mar 29, 2022
View reviewed changes

@shuaijinchao shuaijinchao left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

guitu168
guitu168 approved these changes Mar 29, 2022
View reviewed changes

@guitu168 guitu168 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

leslie-tsang
leslie-tsang approved these changes Mar 29, 2022
View reviewed changes

@leslie-tsang leslie-tsang left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

SkyeYoung
SkyeYoung approved these changes Mar 29, 2022
View reviewed changes

@SkyeYoung SkyeYoung left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

@yzeng25
yzeng25 merged commit 6024443 into apache:master Mar 30, 2022
@pottekkat
pottekkat deleted the docs/style-guide/6672 branch March 30, 2022 01:32
@juzhiyuan juzhiyuan mentioned this pull request Mar 30, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@juzhiyuan juzhiyuan juzhiyuan left review comments
@yzeng25 yzeng25 yzeng25 left review comments
@lilien1010 lilien1010 lilien1010 approved these changes
@shuaijinchao shuaijinchao shuaijinchao approved these changes
@SkyeYoung SkyeYoung SkyeYoung approved these changes
@leslie-tsang leslie-tsang leslie-tsang approved these changes
@okaybase okaybase okaybase left review comments
@membphis membphis Awaiting requested review from membphis
@SylviaBABY SylviaBABY Awaiting requested review from SylviaBABY
@tokers tokers Awaiting requested review from tokers
@tzssangglass tzssangglass Awaiting requested review from tzssangglass
@Yiyiyimu Yiyiyimu Awaiting requested review from Yiyiyimu
+2 more reviewers
@avinal avinal avinal approved these changes
@guitu168 guitu168 guitu168 approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Proposal: create a style guide to ensure consistency in documentation