Anonymitaet commented on code in PR #396: URL: https://github.com/apache/pulsar-site/pull/396#discussion_r1095251146
########## contribute/site-intro.md: ########## @@ -0,0 +1,110 @@ +# Introduction + +The Pulsar site is built with [Docusaurus](http://docusaurus.io/) framework. You can find all technical details on [its docs](https://docusaurus.io/docs). + +Specifically, this chapter provides a [writing syntax](document-syntax.md) guide selecting knowledge for writing content of the site. + +## Source + +Currently, the source of the site is located at the [apache/pulsar-site](http://github.com/apache/pulsar-site) repo. + +## Pages + +Docusaurus provides three kinds of pages out-of-the-box: [docs](https://docusaurus.io/docs/docs-introduction), [blogs](https://docusaurus.io/docs/blog), and [JSX pages](https://docusaurus.io/docs/creating-pages). + +The Pulsar site pages are of: + +| Page | Type | Source | +|--------------------------------------------|-----------|---------------------------------------------------------------------------------------------------| +| [User docs](pathname:///docs) | docs | <ul><li>docs/</li><li>versioned_docs/</li><li>versioned_sidebars/</li><li>sidebars.json</li></ul> | +| [Contrib guides](about.md) | docs | <ul><li>contribute/</li><li>sidebarsDevelopment.js</li></ul> | +| [Release notes](pathname:///release-notes) | docs | <ul><li>release-notes/</li><li>sidebarsReleaseNotes.js</li></ul> | +| [Security](pathname:///security) | docs | <ul><li>security/</li></ul> | +| [Blogs](pathname:///blog) | blog | <ul><li>blog/</li></ul> | +| Other pages | JSX pages | <ul><li>src/pages/</li></ul> | + +Besides, the site serves multiple static pages generated outside the framework, including API docs, reference docs, and swagger files. You can find them under the `static` folder. + +## Tools + +### preview.sh + +The most commonly used tools is `preview.sh`. You can preview your local changes by: Review Comment: ```suggestion The most commonly used tool is `preview.sh`. You can preview your local changes by: ``` ########## contribute/site-intro.md: ########## @@ -0,0 +1,110 @@ +# Introduction + +The Pulsar site is built with [Docusaurus](http://docusaurus.io/) framework. You can find all technical details on [its docs](https://docusaurus.io/docs). + +Specifically, this chapter provides a [writing syntax](document-syntax.md) guide selecting knowledge for writing content of the site. + +## Source + +Currently, the source of the site is located at the [apache/pulsar-site](http://github.com/apache/pulsar-site) repo. + +## Pages + +Docusaurus provides three kinds of pages out-of-the-box: [docs](https://docusaurus.io/docs/docs-introduction), [blogs](https://docusaurus.io/docs/blog), and [JSX pages](https://docusaurus.io/docs/creating-pages). + +The Pulsar site pages are of: + +| Page | Type | Source | +|--------------------------------------------|-----------|---------------------------------------------------------------------------------------------------| +| [User docs](pathname:///docs) | docs | <ul><li>docs/</li><li>versioned_docs/</li><li>versioned_sidebars/</li><li>sidebars.json</li></ul> | +| [Contrib guides](about.md) | docs | <ul><li>contribute/</li><li>sidebarsDevelopment.js</li></ul> | +| [Release notes](pathname:///release-notes) | docs | <ul><li>release-notes/</li><li>sidebarsReleaseNotes.js</li></ul> | +| [Security](pathname:///security) | docs | <ul><li>security/</li></ul> | +| [Blogs](pathname:///blog) | blog | <ul><li>blog/</li></ul> | +| Other pages | JSX pages | <ul><li>src/pages/</li></ul> | + +Besides, the site serves multiple static pages generated outside the framework, including API docs, reference docs, and swagger files. You can find them under the `static` folder. + +## Tools + +### preview.sh + +The most commonly used tools is `preview.sh`. You can preview your local changes by: + +```shell +./preview.sh 2.11.x +``` + +See the [previewing content](document-preview.md) guide for more details. + +### docker-compose.yaml + +The `preview.sh` script use the Docusaurus dev server for testing, which is different from the real Apache Web Server based env that serves the site online. + +To emulate the server-side logics, like `.htaccess` rewrite rules, you can run: + +```shell +yarn build +docker-compose up +``` + +### Pytools + +The site repo has a set of Python scripts for generating content and syncing/updating/publish the site. + +You can read the [README](https://github.com/apache/pulsar-site/tree/main/tools/pytools/README.md) file of pytools for details. + +## How-tos + +This section holds common how-tos about website maintenance and troubleshooting. + +### How to fix search index mismatches? + +First of all, you should get the permission to access `apache_pulsar` crawler on [Algolia Crawler console](https://crawler.algolia.com/). You can email [email protected] to ask for permission. Review Comment: ```suggestion First of all, you should get permission to access `apache_pulsar` crawler on [Algolia Crawler console](https://crawler.algolia.com/). You can email [email protected] to ask for permission. ``` ########## contribute/site-intro.md: ########## @@ -0,0 +1,110 @@ +# Introduction + +The Pulsar site is built with [Docusaurus](http://docusaurus.io/) framework. You can find all technical details on [its docs](https://docusaurus.io/docs). + +Specifically, this chapter provides a [writing syntax](document-syntax.md) guide selecting knowledge for writing content of the site. + +## Source + +Currently, the source of the site is located at the [apache/pulsar-site](http://github.com/apache/pulsar-site) repo. + +## Pages + +Docusaurus provides three kinds of pages out-of-the-box: [docs](https://docusaurus.io/docs/docs-introduction), [blogs](https://docusaurus.io/docs/blog), and [JSX pages](https://docusaurus.io/docs/creating-pages). + +The Pulsar site pages are of: + +| Page | Type | Source | +|--------------------------------------------|-----------|---------------------------------------------------------------------------------------------------| +| [User docs](pathname:///docs) | docs | <ul><li>docs/</li><li>versioned_docs/</li><li>versioned_sidebars/</li><li>sidebars.json</li></ul> | +| [Contrib guides](about.md) | docs | <ul><li>contribute/</li><li>sidebarsDevelopment.js</li></ul> | +| [Release notes](pathname:///release-notes) | docs | <ul><li>release-notes/</li><li>sidebarsReleaseNotes.js</li></ul> | +| [Security](pathname:///security) | docs | <ul><li>security/</li></ul> | +| [Blogs](pathname:///blog) | blog | <ul><li>blog/</li></ul> | +| Other pages | JSX pages | <ul><li>src/pages/</li></ul> | + +Besides, the site serves multiple static pages generated outside the framework, including API docs, reference docs, and swagger files. You can find them under the `static` folder. + +## Tools + +### preview.sh + +The most commonly used tools is `preview.sh`. You can preview your local changes by: + +```shell +./preview.sh 2.11.x +``` + +See the [previewing content](document-preview.md) guide for more details. + +### docker-compose.yaml + +The `preview.sh` script use the Docusaurus dev server for testing, which is different from the real Apache Web Server based env that serves the site online. + +To emulate the server-side logics, like `.htaccess` rewrite rules, you can run: + +```shell +yarn build +docker-compose up +``` + +### Pytools + +The site repo has a set of Python scripts for generating content and syncing/updating/publish the site. Review Comment: ```suggestion The site repo has a set of Python scripts for generating content and syncing/updating/publishing the site. ``` ########## contribute/site-intro.md: ########## @@ -0,0 +1,110 @@ +# Introduction + +The Pulsar site is built with [Docusaurus](http://docusaurus.io/) framework. You can find all technical details on [its docs](https://docusaurus.io/docs). + +Specifically, this chapter provides a [writing syntax](document-syntax.md) guide selecting knowledge for writing content of the site. + +## Source + +Currently, the source of the site is located at the [apache/pulsar-site](http://github.com/apache/pulsar-site) repo. + +## Pages + +Docusaurus provides three kinds of pages out-of-the-box: [docs](https://docusaurus.io/docs/docs-introduction), [blogs](https://docusaurus.io/docs/blog), and [JSX pages](https://docusaurus.io/docs/creating-pages). + +The Pulsar site pages are of: + +| Page | Type | Source | +|--------------------------------------------|-----------|---------------------------------------------------------------------------------------------------| +| [User docs](pathname:///docs) | docs | <ul><li>docs/</li><li>versioned_docs/</li><li>versioned_sidebars/</li><li>sidebars.json</li></ul> | +| [Contrib guides](about.md) | docs | <ul><li>contribute/</li><li>sidebarsDevelopment.js</li></ul> | Review Comment: ```suggestion | [Contribution guides](about.md) | docs | <ul><li>contribute/</li><li>sidebarsDevelopment.js</li></ul> | ``` -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
