[GitHub] [apisix-website] yzeng25 commented on a change in pull request #776: docs: add contribution guidelines
yzeng25 commented on a change in pull request #776: URL: https://github.com/apache/apisix-website/pull/776#discussion_r758082999 ## File path: CONTRIBUTING.md ## @@ -0,0 +1,338 @@ +# Apache APISIX Blog Contributing Guide + +## Overview + +Welcome to Apache APISIX's website and blog repository. + +This guideline will teach you how to contribute if you want to add a new blog, or modify existing blog contents. + +If you find an issue on current documents, please feel free to file an issue to let the community know about it, or you can sumbit a pull request to fix or update. Both actions are welcome and recommended. + +The blogs are written in two languages: English and Chinese. We encourage contributors to add blogs in their preferred language. It is completely up to you. We can handle translations and ask you to do a pull request review later. + +English blogs are located in the `website/blog` directory, in which they are categorized by year, month and date. For example, `website/blog/2021/11/22/develop-apisix-ingress-with-nocalhost-in-kubernetes.md` means that a blog named `develop-apisix-ingress-with-nocalhost-in-kubernetes.md` was published on November 22nd, 2021, and it is located in the `website/blog/2021/11/22 directory`. + +Similarly, Chinese blogs are located in `website/i18n/zh/docusaurus-plugin-content-blog` directory and follow the same rules described above. + +## What you can contribute + +### Add a new blog + +To add a new blog, please perform the following steps: + +1. Find the right place to store your blog. +1. If you plan to submit a blog written in English, please create a markdown file under `website/blog` directory. +2. If you plan to submit a blog written in Chinese, please create a markdown file under `website/i18n/zh/docusaurus-plugin-content-blog` directory. +3. If you cannot find an existing year, month, or date directory that fits your desired published date, you can go ahead and create such directory on your own. + +2. Create a markdown file in the directory. Please make sure that the file name is written in English with **no** capitalized letters. During review session, we may suggest changing it to achieve better SEO performance. (Yes, currently some files names contain capitalized letters, we are working on it, see https://github.com/apache/apisix-website/issues/713) + +3. Add text, images, diagrams, charts to the markdown file. +1. There is nothing much to say about adding text. +2. To add images, please upload images to https://markdown.apiseven.com/#/ , and copy the links from there. +3. To add charts or diagrams, we are happy to see any sort of charts and diagrams, as long as it formats correctly on the page. From previous experience, charts with 4 columns or less are the perfect size displayed on screen. + +4. Optional: run locally to inspect any typos or formatting issues left behind. Although we implemented lint and error checks in the repository, we suggest running it locally to avoid repeated work. To run it locally, please run `cd website`, and then run `yarn start` commands in your terminal. + +5. Submit a pull request to our repository. + + Blog's header information + +Our blogs start with a header like this: + +``` +title: "blog's title" +author: "blog's author" +authorURL: "author's GitHub ID" +authorImageURL: "author's GitHub Image" +keywords: +- keywords 1 +- keywords 2 +- keywords 3 +- keywords 4 +- keywords 5 +description: description of this blog +tags: [tag1] +``` + +# title + +Required field, the title of the article, the standard expression in the form of `title: "title"`, although the actual test single quotation marks or no quotation marks can be, but in order to maintain the standard, the unified use of English double quotation marks to wrap the text. + +# author + +Required field, the article's author name, the standard form of expression for author: "author", although the actual test single quotation marks or no quotation marks can be, but in order to maintain the standard, the unified use of English double quotation marks to wrap the text. + +1. community author: if you are willing to provide your real name, use your real name, if not, use your GitHub account name. + +2. business case authors: real names, such as John Doe. + +# authorURL + +For business users or business cases, you can leave this item blank. Because GitHub is personal, and in the case of a business case, the person represents his company rather than himself, it is recommended that you leave this blank to avoid unnecessary controversy. This does not mean leave `authorURL`: blank, it means just delete the entire line that corresponds to it, including the variable name. + +# authorImageURL + +The author's GitHub avatar, it is related with `authorURL`. For the same reason described above, this is an optional field. See below for how to get the avatar. + +# keywords + +Required
[GitHub] [apisix-website] yzeng25 commented on a change in pull request #776: docs: add contribution guidelines
yzeng25 commented on a change in pull request #776: URL: https://github.com/apache/apisix-website/pull/776#discussion_r758064397 ## File path: CONTRIBUTING.md ## @@ -0,0 +1,338 @@ +# Apache APISIX Blog Contributing Guide Review comment: Ok I will move this document under `website/docs/general` and update `sidebars.json` accordingly. ## File path: CONTRIBUTING.md ## @@ -0,0 +1,338 @@ +# Apache APISIX Blog Contributing Guide + +## Overview + +Welcome to Apache APISIX's website and blog repository. + +This guideline will teach you how to contribute if you want to add a new blog, or modify existing blog contents. + +If you find an issue on current documents, please feel free to file an issue to let the community know about it, or you can sumbit a pull request to fix or update. Both actions are welcome and recommended. + +The blogs are written in two languages: English and Chinese. We encourage contributors to add blogs in their preferred language. It is completely up to you. We can handle translations and ask you to do a pull request review later. + +English blogs are located in the `website/blog` directory, in which they are categorized by year, month and date. For example, `website/blog/2021/11/22/develop-apisix-ingress-with-nocalhost-in-kubernetes.md` means that a blog named `develop-apisix-ingress-with-nocalhost-in-kubernetes.md` was published on November 22nd, 2021, and it is located in the `website/blog/2021/11/22 directory`. + +Similarly, Chinese blogs are located in `website/i18n/zh/docusaurus-plugin-content-blog` directory and follow the same rules described above. + +## What you can contribute + +### Add a new blog Review comment: Yes, descriptions are added. -- 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-unsubscr...@apisix.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
[GitHub] [apisix-website] yzeng25 commented on a change in pull request #776: docs: add contribution guidelines
yzeng25 commented on a change in pull request #776: URL: https://github.com/apache/apisix-website/pull/776#discussion_r757982507 ## File path: CONTRIBUTING.md ## @@ -0,0 +1,338 @@ +# Apache APISIX Blog Contributing Guide + +## Overview + +Welcome to Apache APISIX's website and blog repository. + +This guideline will teach you how to contribute if you want to add a new blog, or modify existing blog contents. + +If you find an issue on current documents, please feel free to file an issue to let the community know about it, or you can sumbit a pull request to fix or update. Both actions are welcome and recommended. + +The blogs are written in two languages: English and Chinese. We encourage contributors to add blogs in their preferred language. It is completely up to you. We can handle translations and ask you to do a pull request review later. + +English blogs are located in the `website/blog` directory, in which they are categorized by year, month and date. For example, `website/blog/2021/11/22/develop-apisix-ingress-with-nocalhost-in-kubernetes.md` means that a blog named `develop-apisix-ingress-with-nocalhost-in-kubernetes.md` was published on November 22nd, 2021, and it is located in the `website/blog/2021/11/22 directory`. + +Similarly, Chinese blogs are located in website/i18n/zh/docusaurus-plugin-content-blog directory and follow the same rules described above. Review comment: ```suggestion Similarly, Chinese blogs are located in `website/i18n/zh/docusaurus-plugin-content-blog` directory and follow the same rules described above. ``` ## File path: CONTRIBUTING.md ## @@ -0,0 +1,338 @@ +# Apache APISIX Blog Contributing Guide + +## Overview + +Welcome to Apache APISIX's website and blog repository. + +This guideline will teach you how to contribute if you want to add a new blog, or modify existing blog contents. + +If you find an issue on current documents, please feel free to file an issue to let the community know about it, or you can sumbit a pull request to fix or update. Both actions are welcome and recommended. + +The blogs are written in two languages: English and Chinese. We encourage contributors to add blogs in their preferred language. It is completely up to you. We can handle translations and ask you to do a pull request review later. + +English blogs are located in the `website/blog` directory, in which they are categorized by year, month and date. For example, `website/blog/2021/11/22/develop-apisix-ingress-with-nocalhost-in-kubernetes.md` means that a blog named `develop-apisix-ingress-with-nocalhost-in-kubernetes.md` was published on November 22nd, 2021, and it is located in the `website/blog/2021/11/22 directory`. + +Similarly, Chinese blogs are located in website/i18n/zh/docusaurus-plugin-content-blog directory and follow the same rules described above. + +## What you can contribute + +### Add a new blog + +To add a new blog, please perform the following steps: + +1. Find the right place to store your blog. +1. If you plan to submit a blog written in English, please create a markdown file under `website/blog` directory. +2. If you plan to submit a blog written in Chinese, please create a markdown file under `website/i18n/zh/docusaurus-plugin-content-blog` directory. +3. If you cannot find an existing year, month, or date directory that fits your desired published date, you can go ahead and create such directory on your own. + +2. Create a markdown file in the directory. Please make sure that the file name is written in English with no capitalized letters. During review session, we may suggest changing it to achieve better SEO performance. (Yes, currently some files names contain capitalized letters, we are working on it, see https://github.com/apache/apisix-website/issues/713) + +3. Add text, images, diagrams, charts to the markdown file. +1. There is nothing much to say about adding text. +2. To add images, please upload images to https://markdown.apiseven.com/#/ , and copy the links from there. +3. To add charts or diagrams, we are happy to see any sort of charts and diagrams, as long as it formats correctly on the page. From previous experience, charts with 4 columns or less are the perfect size displayed on screen. + +4. Optional: run locally to inspect any typos or formatting issues left behind. We highly recommend running the website locally before submission. Although we implemented lint and error checks in the repository, we suggest running it locally to avoid repeated work. To run it locally, please run `cd website`, and then run `yarn start` commands in your terminal. + +5. Submit a pull request to our repository. + + Blog's header information + +Our blogs start with a header like this: + +``` +title: "blog's title" +author: "blog's author" +authorURL: "author's GitHub ID" +authorImageURL: "author's GitHub Image" +keywords: +- keywords 1 +- keywords 2 +-
