You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by GitBox <gi...@apache.org> on 2022/03/30 06:17:52 UTC
[GitHub] [apisix-website] SkyeYoung opened a new issue #989: [Docs]: update README.md
SkyeYoung opened a new issue #989:
URL: https://github.com/apache/apisix-website/issues/989
### Current State
**Description of the current state/issue**:
Related: https://github.com/apache/apisix-website/pull/984, https://github.com/apache/apisix-website/pull/986, https://github.com/apache/apisix-website/pull/972
After above PRs are merged, We need to update README.md to help contributors develop and build.
**Link to the page**:
none
**Screenshots (if relevant)**:
none
### Desired State
**Description of the change you are proposing**:
### Would you like to fix this issue?
Yes! Count me in
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-website] SkyeYoung edited a comment on issue #989: [Docs]: update README.md
Posted by GitBox <gi...@apache.org>.
SkyeYoung edited a comment on issue #989:
URL: https://github.com/apache/apisix-website/issues/989#issuecomment-1083927905
> Yes !! i am interested to work in it , do let me know what changes need to be done
@Ps066 Great!
The main content we need to amend is the Usage. So what you can do is:
1. rewrite current part, now we just need to run `yarn start` under the project root directory
2. now it's all about dev mode guide, we need to add build related guidance. (For example, `yarn build && yarn docusaurus serve --host 0.0.0.0` )
3. write down some commands, instructions, and document links you think everyone may need in the deployment process.
4. keep it as simple and necessary as possible
Refs:
1. https://github.com/apache/apisix-website/blob/master/.github/workflows/deploy.yml
2. https://github.com/apache/apisix-website/blob/f37b8af223966f6f32480bd4ec5c2eb8aa29ec1a/package.json
3. https://docusaurus.io/docs/cli
4. https://yarnpkg.com/cli/workspace
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-website] SkyeYoung commented on issue #989: [Docs]: update README.md
Posted by GitBox <gi...@apache.org>.
SkyeYoung commented on issue #989:
URL: https://github.com/apache/apisix-website/issues/989#issuecomment-1083927905
> Yes !! i am interested to work in it , do let me know what changes need to be done
@Ps066 Great!
The main content we need to supplement is the Usage. So what you can do is:
1. rewrite current part, now we just need to run `yarn start` under the project root directory
2. now it's all about dev mode guide, we need to add build related guidance. (For example, `yarn build && yarn docusaurus serve --host 0.0.0.0` )
3. write down some commands, instructions, and document links you think everyone may need in the deployment process.
4. keep it as simple and necessary as possible
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-website] SkyeYoung edited a comment on issue #989: [Docs]: update README.md
Posted by GitBox <gi...@apache.org>.
SkyeYoung edited a comment on issue #989:
URL: https://github.com/apache/apisix-website/issues/989#issuecomment-1083927905
> Yes !! i am interested to work in it , do let me know what changes need to be done
@Ps066 Great!
The main content we need to amend is the Usage. So what you can do is:
1. rewrite current part, now we just need to run `yarn start` under the project root directory
2. now it's all about dev mode guide, we need to add build related guidance. (For example, `yarn build && yarn docusaurus serve --host 0.0.0.0` )
3. write down some commands, instructions, and document links you think everyone may need in the deployment process.
4. keep it as simple and necessary as possible
Refs:
1. https://github.com/apache/apisix-website/blob/master/.github/workflows/deploy.yml
2. https://github.com/apache/apisix-website/blob/f37b8af223966f6f32480bd4ec5c2eb8aa29ec1a/package.json#L10
3. https://docusaurus.io/docs/cli
4. https://yarnpkg.com/cli/workspace
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-website] SkyeYoung edited a comment on issue #989: [Docs]: update README.md
Posted by GitBox <gi...@apache.org>.
SkyeYoung edited a comment on issue #989:
URL: https://github.com/apache/apisix-website/issues/989#issuecomment-1083927905
> Yes !! i am interested to work in it , do let me know what changes need to be done
@Ps066 Great!
The main content we need to amend is the Usage. So what you can do is:
1. rewrite current part, now we just need to run `yarn start` under the project root directory
2. now it's all about dev mode guide, we need to add build related guidance. (For example, `yarn build && yarn docusaurus serve --host 0.0.0.0` )
3. write down some commands, instructions, and document links you think everyone may need in the deployment process.
4. keep it as simple and necessary as possible
Refs:
1. https://github.com/apache/apisix-website/blob/master/.github/workflows/deploy.yml
2. https://docusaurus.io/docs/cli
3. https://yarnpkg.com/cli/workspace
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-website] SkyeYoung edited a comment on issue #989: [Docs]: update README.md
Posted by GitBox <gi...@apache.org>.
SkyeYoung edited a comment on issue #989:
URL: https://github.com/apache/apisix-website/issues/989#issuecomment-1083927905
> Yes !! i am interested to work in it , do let me know what changes need to be done
@Ps066 Great!
The main content we need to amend is the Usage. So what you can do is:
1. rewrite current part, now we just need to run `yarn start` under the project root directory
2. now it's all about dev mode guide, we need to add build related guidance. (For example, `yarn build && yarn docusaurus serve --host 0.0.0.0` )
3. write down some commands, instructions, and document links you think everyone may need in the deployment process.
4. keep it as simple and necessary as possible
Refs:
1. https://github.com/apache/apisix-website/blob/master/.github/workflows/deploy.yml
2. https://github.com/apache/apisix-website/blob/master/package.json
3. https://docusaurus.io/docs/cli
4. https://yarnpkg.com/cli/workspace
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-website] Ps066 commented on issue #989: [Docs]: update README.md
Posted by GitBox <gi...@apache.org>.
Ps066 commented on issue #989:
URL: https://github.com/apache/apisix-website/issues/989#issuecomment-1084620699
thankyou @SkyeYoung for assigning me , and helping me !! i started working on it will complete as soon as possible
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-website] Ps066 removed a comment on issue #989: [Docs]: update README.md
Posted by GitBox <gi...@apache.org>.
Ps066 removed a comment on issue #989:
URL: https://github.com/apache/apisix-website/issues/989#issuecomment-1085993803
Fixes #989
Changes done :-
- [X] Added a basic guide for Environment setup
- [X] Added a guide to start & run the server
- [X] Tried to simplify the Docusaurus Documentation
Screenshots :-
Have a look to documentation , at [https://github.com/Ps066/apisix-website/blob/master/README.md](url)
Please look through the new Readme documentations , and do let me know if any changes are required.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-website] SkyeYoung edited a comment on issue #989: [Docs]: update README.md
Posted by GitBox <gi...@apache.org>.
SkyeYoung edited a comment on issue #989:
URL: https://github.com/apache/apisix-website/issues/989#issuecomment-1083927905
> Yes !! i am interested to work in it , do let me know what changes need to be done
@Ps066 Great!
The main content we need to supplement is the Usage. So what you can do is:
1. rewrite current part, now we just need to run `yarn start` under the project root directory
2. now it's all about dev mode guide, we need to add build related guidance. (For example, `yarn build && yarn docusaurus serve --host 0.0.0.0` )
3. write down some commands, instructions, and document links you think everyone may need in the deployment process.
4. keep it as simple and necessary as possible
Refs:
1. https://github.com/apache/apisix-website/blob/master/.github/workflows/deploy.yml
2. https://docusaurus.io/docs/cli
3. https://yarnpkg.com/cli/workspace
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-website] SkyeYoung edited a comment on issue #989: [Docs]: update README.md
Posted by GitBox <gi...@apache.org>.
SkyeYoung edited a comment on issue #989:
URL: https://github.com/apache/apisix-website/issues/989#issuecomment-1083927905
> Yes !! i am interested to work in it , do let me know what changes need to be done
@Ps066 Great!
The main content we need to supplement is the Usage. So what you can do is:
1. rewrite current part, now we just need to run `yarn start` under the project root directory
2. now it's all about dev mode guide, we need to add build related guidance. (For example, `yarn build && yarn docusaurus serve --host 0.0.0.0` )
3. write down some commands, instructions, and document links you think everyone may need in the deployment process.
4. keep it as simple and necessary as possible
Refs:
1. https://docusaurus.io/docs/cli
2. https://github.com/apache/apisix-website/blob/master/.github/workflows/deploy.yml
3. https://yarnpkg.com/cli/workspace
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-website] Ps066 commented on issue #989: [Docs]: update README.md
Posted by GitBox <gi...@apache.org>.
Ps066 commented on issue #989:
URL: https://github.com/apache/apisix-website/issues/989#issuecomment-1083327131
Yes !! i am interested to work in it , do let me know what changes need to be done
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-website] Ps066 commented on issue #989: [Docs]: update README.md
Posted by GitBox <gi...@apache.org>.
Ps066 commented on issue #989:
URL: https://github.com/apache/apisix-website/issues/989#issuecomment-1085993803
Fixes #989
Changes done :-
- [X] Added a basic guide for Environment setup
- [X] Added a guide to start & run the server
- [X] Tried to simplify the Docusaurus Documentation
Screenshots :-
Have a look to documentation , at [https://github.com/Ps066/apisix-website/blob/master/README.md](url)
Please look through the new Readme documentations , and do let me know if any changes are required.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org