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/08/03 08:23:52 UTC
[GitHub] [pulsar] momo-jun opened a new pull request, #16925: [PIP-190][doc] Generate 2.10.x docs
momo-jun opened a new pull request, #16925:
URL: https://github.com/apache/pulsar/pull/16925
### Motivation
Refer to [PIP-190](https://github.com/apache/pulsar/issues/16637).
### Modifications
1. Rename versioned_docs/version-2.10.0 to version-2.10.x
2. Add 2.10.1 specific doc changes to 2.10.x docs.
Note that the docs for 2.10.1 will be cleaned up after other prep work is done.
### Documentation
- [ ] `doc`
--
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] momo-jun commented on pull request #16925: [feature][doc]PIP-190: Generate 2.10.x/2.9.x/2.8.x docs
Posted by GitBox <gi...@apache.org>.
momo-jun commented on PR #16925:
URL: https://github.com/apache/pulsar/pull/16925#issuecomment-1209042661
Hi @urfreespace, as @Anonymitaet suggested, if we add `deprecated` to the folders as a comprise to balance the confusion elimination and the potential external link issue, do you see any risk here? If it's good to go, I will rename these folders in this PR as well.
--
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] momo-jun commented on pull request #16925: [feature][doc]PIP-190: Generate 2.10.x/2.9.x/2.8.x docs
Posted by GitBox <gi...@apache.org>.
momo-jun commented on PR #16925:
URL: https://github.com/apache/pulsar/pull/16925#issuecomment-1207578971
@Anonymitaet Thanks for your suggestions.
> 1. How about not deleting 2.8.1/2.8.2/2.8.3/2.9.1/2.9.2/2.9.3/2.10.1 docs since there might be some occurrences referencing them? We can just not show them.
Keeping these obsolete docs may confuse contributors and lead to errors when they update them.
On the other hand, I searched in the versioned docs and there were no cross-version links found. If we do have such occurrences, we should fix them.
> 2. How about adding some explanations for this PR change on https://pulsar.apache.org/versions? So that users will not be confused by the different version formats (`2.10.x/2.9.x/2.8.x` and `2.7.4/2.7.3/2.7.2/2.7.1/...`).
I will try to add some explanations there.
--
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] momo-jun commented on pull request #16925: [feature][doc]PIP-190: Generate 2.10.x/2.9.x/2.8.x docs
Posted by GitBox <gi...@apache.org>.
momo-jun commented on PR #16925:
URL: https://github.com/apache/pulsar/pull/16925#issuecomment-1210673642
@Anonymitaet Yes, I talked with @urfreespace about the renaming today.
@urfreespace Can you pls help confirm it to avoid any misunderstanding here?
--
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] urfreespace commented on pull request #16925: [feature][doc]PIP-190: Generate 2.10.x/2.9.x/2.8.x docs
Posted by GitBox <gi...@apache.org>.
urfreespace commented on PR #16925:
URL: https://github.com/apache/pulsar/pull/16925#issuecomment-1210055736
> Hi @urfreespace, as @Anonymitaet suggested, if we add `deprecated` to the folders as a comprise to balance the confusion elimination and the potential external link issue, do you see any risk here? If it's good to go, I will rename these folders in this PR as well.
I think it's a good idea, but I suggest we should make another PR to do that after we merged this PR and make sure it's working well
--
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] momo-jun commented on pull request #16925: [feature][doc]PIP-190: Generate 2.10.x/2.9.x/2.8.x docs
Posted by GitBox <gi...@apache.org>.
momo-jun commented on PR #16925:
URL: https://github.com/apache/pulsar/pull/16925#issuecomment-1205961966
Ping @Anonymitaet @urfreespace for review.
This PR needs to work with #16938.
--
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] momo-jun commented on pull request #16925: [feature][doc]PIP-190: Generate 2.10.x/2.9.x/2.8.x docs
Posted by GitBox <gi...@apache.org>.
momo-jun commented on PR #16925:
URL: https://github.com/apache/pulsar/pull/16925#issuecomment-1206018808
@BewareMyPower FYI - with this change implemented, you don't need to generate docs for the upcoming 2.8.4 release.
--
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 #16925: [feature][doc]PIP-190: Generate 2.10.x/2.9.x/2.8.x docs
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on PR #16925:
URL: https://github.com/apache/pulsar/pull/16925#issuecomment-1207561777
1. How about not deleting 2.8.1/2.8.2/2.8.3/2.9.1/2.9.2/2.9.3/2.10.1 docs since there might be some occurrences referencing them? We can just not show them.
2. How about adding some explanations for this PR change on https://pulsar.apache.org/versions? So that users will not be confused by the different version formats (`2.10.x/2.9.x/2.8.x` and `2.7.4/2.7.3/2.7.2/2.7.1/...`).
--
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 #16925: [feature][doc]PIP-190: Generate 2.10.x/2.9.x/2.8.x docs
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on PR #16925:
URL: https://github.com/apache/pulsar/pull/16925#issuecomment-1207670672
> How about not deleting 2.8.1/2.8.2/2.8.3/2.9.1/2.9.2/2.9.3/2.10.1 docs since there might be some occurrences referencing them? We can just not show them.
Keeping these obsolete docs may confuse contributors and lead to errors when they update them.
On the other hand, I searched in the versioned docs and there were no cross-version links found. If we do have such occurrences, we should fix them.
I mean the outside occurrences rather than internal ones
--
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] urfreespace commented on pull request #16925: [feature][doc]PIP-190: Generate 2.10.x/2.9.x/2.8.x docs
Posted by GitBox <gi...@apache.org>.
urfreespace commented on PR #16925:
URL: https://github.com/apache/pulsar/pull/16925#issuecomment-1211615274
> @Anonymitaet Yes, I talked with @urfreespace about the renaming today. @urfreespace Can you pls help confirm it to avoid any misunderstanding here?
yes, we should consider creating another PR for the work of renaming after the current PR merged and make sure it's working well
--
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] momo-jun commented on pull request #16925: [feature][doc]PIP-190: Generate 2.10.x/2.9.x/2.8.x docs
Posted by GitBox <gi...@apache.org>.
momo-jun commented on PR #16925:
URL: https://github.com/apache/pulsar/pull/16925#issuecomment-1210061368
@Anonymitaet adding `deprecated` to those folders will change the URLs of doc pages, which also breaks the external references. If that's the case, I think I will also have to close the PR and open another one to avoid renaming the current 2.10.0/2.9.0/2.8.0 doc sets.
--
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 #16925: [feature][doc]PIP-190: Generate 2.10.x/2.9.x/2.8.x docs
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on PR #16925:
URL: https://github.com/apache/pulsar/pull/16925#issuecomment-1210096404
> @Anonymitaet adding `deprecated` to those folders will change the URLs of doc pages, which also breaks the external references. If that's the case, I think I will also have to close the PR and open another one to avoid renaming the current 2.10.0/2.9.0/2.8.0 doc sets.
You mean the red is determined by the green?
<img width="1919" alt="image" src="https://user-images.githubusercontent.com/50226895/183801362-1193e23c-e432-4d04-8dd5-00a80011f028.png">
--
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] momo-jun closed pull request #16925: [feature][doc]PIP-190: Generate 2.10.x/2.9.x/2.8.x docs
Posted by GitBox <gi...@apache.org>.
momo-jun closed pull request #16925: [feature][doc]PIP-190: Generate 2.10.x/2.9.x/2.8.x docs
URL: https://github.com/apache/pulsar/pull/16925
--
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] urfreespace commented on pull request #16925: [feature][doc]PIP-190: Generate 2.10.x/2.9.x/2.8.x docs
Posted by GitBox <gi...@apache.org>.
urfreespace commented on PR #16925:
URL: https://github.com/apache/pulsar/pull/16925#issuecomment-1207603363
@momo-jun pls resolve the conflicts
--
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