You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by GitBox <gi...@apache.org> on 2022/12/29 03:03:07 UTC

[GitHub] [pulsar] tisonkun opened a new pull request, #19100: [refactor] Remove docs from the main repo

tisonkun opened a new pull request, #19100:
URL: https://github.com/apache/pulsar/pull/19100

   This closes https://github.com/apache/pulsar/issues/19092.
   
   Mailing list resolution: https://lists.apache.org/thread/89wl112cflvtoyfg3l7kglr1dozsljm9
   
   All pending PRs updating `site2` content should be resubmitted. I'm trying to merge them if acceptable now.
   
   ### Does this pull request potentially affect one of the following parts:
   
   <!-- DO NOT REMOVE THIS SECTION. CHECK THE PROPER BOX ONLY. -->
   
   *If the box was checked, please highlight the changes*
   
   - [ ] Dependencies (add or upgrade a dependency)
   - [ ] The public API
   - [ ] The schema
   - [ ] The default values of configurations
   - [ ] The threading model
   - [ ] The binary protocol
   - [ ] The REST endpoints
   - [ ] The admin CLI options
   - [ ] The metrics
   - [ ] Anything that affects deployment
   
   ### Documentation
   
   <!-- DO NOT REMOVE THIS SECTION. CHECK THE PROPER BOX ONLY. -->
   
   - [x] `doc` <!-- Your PR contains doc changes. Please attach the local preview screenshots (run `sh start.sh` at `pulsar/site2/website`) to your PR description, or else your PR might not get merged. -->
   - [ ] `doc-required` <!-- Your PR changes impact docs and you will update later -->
   - [ ] `doc-not-needed` <!-- Your PR changes do not impact docs -->
   - [ ] `doc-complete` <!-- Docs have been already added -->
   
   ### Matching PR in forked repository
   
   PR in forked repository: <!-- ENTER URL HERE -->
   
   <!--
   After opening this PR, the build in apache/pulsar will fail and instructions will
   be provided for opening a PR in the PR author's forked repository.
   
   apache/pulsar pull requests should be first tested in your own fork since the 
   apache/pulsar CI based on GitHub Actions has constrained resources and quota.
   GitHub Actions provides separate quota for pull requests that are executed in 
   a forked repository.
   
   The tests will be run in the forked repository until all PR review comments have
   been handled, the tests pass and the PR is approved by a reviewer.
   -->
   


-- 
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: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [pulsar] Anonymitaet commented on pull request #19100: [refactor] Remove docs from the main repo

Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on PR #19100:
URL: https://github.com/apache/pulsar/pull/19100#issuecomment-1367047567

   Hi @tisonkun thanks for your work! 
   
   I have several questions, can you take a look? Thank you!
   
   After this PR gets merged,
   
   1. Will the `documentation bot` (used to label PR with doc-related labels) be implemented in `pulsar-site` and removed in `pulsar`?
   
   2. Will the sync workflow (sync docs from `pulsar` to `pulsar-site`) be removed?
   
   3. Will the doc-related issues still be recorded in `pulsar`?
   


-- 
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: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [pulsar] tisonkun merged pull request #19100: [refactor] Remove docs from the main repo

Posted by GitBox <gi...@apache.org>.
tisonkun merged PR #19100:
URL: https://github.com/apache/pulsar/pull/19100


-- 
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: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [pulsar] tisonkun commented on pull request #19100: [refactor] Remove docs from the main repo

Posted by GitBox <gi...@apache.org>.
tisonkun commented on PR #19100:
URL: https://github.com/apache/pulsar/pull/19100#issuecomment-1367302218

   Merging...
   
   @momo-jun @Anonymitaet PRs touch `site2` files need to be resubmitted against [the site repo](https://github.com/apache/pulsar-site). Ping me if any issue.


-- 
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: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [pulsar] tisonkun commented on pull request #19100: [refactor] Remove docs from the main repo

Posted by GitBox <gi...@apache.org>.
tisonkun commented on PR #19100:
URL: https://github.com/apache/pulsar/pull/19100#issuecomment-1367048663

   > Will the documentation bot (used to label PR with doc-related labels) be implemented in pulsar-site and removed in pulsar?
   
   No. At least not yet. There are still PRs in `apache/pulsar` touch docs other than `site2`. Said other markdown files or inline comments. 
   
   But yes, we can install the documentation bot in `apache/pulsar-site` if necessary. Although we may at first try to regard all changes in the site repo is about "doc".
   
   > Will the sync workflow (sync docs from pulsar to pulsar-site) be removed?
   
   See https://github.com/apache/pulsar-site/pull/348. We may still generate CLI references and swagger docs from main repo periodically. But since the docs content gets removed, we don't sync them (nothing to sync, actually).
   
   > Will the doc-related issues still be recorded in pulsar?
   
   Yes.


-- 
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: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [pulsar] Anonymitaet commented on pull request #19100: [refactor] Remove docs from the main repo

Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on PR #19100:
URL: https://github.com/apache/pulsar/pull/19100#issuecomment-1367109622

   > Although we may at first try to regard all changes in the site repo is about "doc".
   They also include website-related changes, e.g., changing the background color. So it's better to have the `doc bot` working in `pulsar-site` and label doc-related PRs with corresponding doc labels.


-- 
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: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [pulsar] tisonkun commented on pull request #19100: [refactor] Remove docs from the main repo

Posted by GitBox <gi...@apache.org>.
tisonkun commented on PR #19100:
URL: https://github.com/apache/pulsar/pull/19100#issuecomment-1367146920

   @Anonymitaet Make sense. File an issue https://github.com/apache/pulsar/issues/19103.
   
   I'll do it as a follow-up.


-- 
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: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org