You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by "Anonymitaet (via GitHub)" <gi...@apache.org> on 2023/03/29 09:09:59 UTC
[GitHub] [pulsar-site] Anonymitaet opened a new pull request, #498: [improve][doc] Optimize Admin API > Features > Functions
Anonymitaet opened a new pull request, #498:
URL: https://github.com/apache/pulsar-site/pull/498
## What issues does this PR solve?
There are some issues in the current [Admin API > Features > Functions](https://pulsar.apache.org/docs/next/admin-api-functions/) doc. I’ve summarized them with the corresponding solutions below.
Issues | Solutions
-- | --
Some operations are in chaotic order. | Categorize operations logically to match users' learning pace. <br><br>For example, classify operations based on the CRUD sequence.
Some docs are redundant and scattered. | Consolidate and optimize the explanations.
Some docs are wrongly placed. <br><br>For example, "Concept"-type docs are shown in Sub-features, while they should be located elsewhere in Pulsar docs. | Move and consolidate them to the correct place.
## What doc changes does this PR introduce?
### ✅ High-level structure changes
- 🍊Old structure
<img width="975" alt="image" src="https://user-images.githubusercontent.com/50226895/228484225-9d5bbc7a-07d3-4703-9ecb-4e0953957d40.png">
- 🍊New structure
<img width="1365" alt="image" src="https://user-images.githubusercontent.com/50226895/228485289-5b3332a5-848e-41ad-80fc-50b0d5209d7e.png">
==================================
- [x] `doc`
Ping @momo-jun @D-2-Ed to review, thank you!
--
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-site] Anonymitaet commented on pull request #498: [improve][doc] Optimize Admin API > Features > Functions
Posted by "Anonymitaet (via GitHub)" <gi...@apache.org>.
Anonymitaet commented on PR #498:
URL: https://github.com/apache/pulsar-site/pull/498#issuecomment-1488223960
Hi @freeznet Could you please review this PR from a technical perspective? Thank you!
--
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-site] Anonymitaet commented on pull request #498: [improve][doc] Optimize Admin API > Features > Functions
Posted by "Anonymitaet (via GitHub)" <gi...@apache.org>.
Anonymitaet commented on PR #498:
URL: https://github.com/apache/pulsar-site/pull/498#issuecomment-1493642552
I've discussed the doc structure with @freeznet and adjusted it as shown in the "Final version" in this [PR description](https://github.com/apache/pulsar-site/pull/498#issue-1645351049).
Reason for this change:
- Devs get accustomed to this sequence of operations. It's natural and easy to use.
- Strictly speaking, some operations can not be categorized in "CRUD" logic.
--
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-site] Anonymitaet commented on pull request #498: [improve][doc] Optimize Admin API > Features > Functions
Posted by "Anonymitaet (via GitHub)" <gi...@apache.org>.
Anonymitaet commented on PR #498:
URL: https://github.com/apache/pulsar-site/pull/498#issuecomment-1493575322
@momo-jun thanks!
For 1:
I prefer to keep it as it is since:
1) If not setting "instance" and "all instances" as headings, then there are no links for them, which makes sharing the link of a specific operation impossible.
2) Previously, I tried to use multiple tabs for "instance" and "all instances" but failed. I guess it is due to Docusraus does not support "embed tabs" (so as [no relevant docs](https://docusaurus.io/docs/next/markdown-features/tabs)).
For 2:
I prefer to keep it as it is since "Restart" is more closely related to the "Create" operation rather than the "Update/Delete" operation because it "wakes up" a function from "sleep" or makes it "alive" from "dead", kind of "creating a life".
--
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-site] Anonymitaet merged pull request #498: [improve][doc] Optimize Admin API > Features > Functions
Posted by "Anonymitaet (via GitHub)" <gi...@apache.org>.
Anonymitaet merged PR #498:
URL: https://github.com/apache/pulsar-site/pull/498
--
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-site] Anonymitaet commented on pull request #498: [improve][doc] Optimize Admin API > Features > Functions
Posted by "Anonymitaet (via GitHub)" <gi...@apache.org>.
Anonymitaet commented on PR #498:
URL: https://github.com/apache/pulsar-site/pull/498#issuecomment-1488223370
The preview looks good:
<img width="1960" alt="image" src="https://user-images.githubusercontent.com/50226895/228485691-16694ad8-48ce-46b5-ac11-03700c0d6418.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-site] Anonymitaet commented on pull request #498: [improve][doc] Optimize Admin API > Features > Functions
Posted by "Anonymitaet (via GitHub)" <gi...@apache.org>.
Anonymitaet commented on PR #498:
URL: https://github.com/apache/pulsar-site/pull/498#issuecomment-1493643416
Hi @freeznet
I've adjusted the doc structure based on your guidance. The preview looks good. Can you review this PR? TIA!
<img width="1919" alt="image" src="https://user-images.githubusercontent.com/50226895/229409382-ac916bef-4b68-40a4-9bbb-007e12056a48.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-site] Anonymitaet commented on pull request #498: [improve][doc] Optimize Admin API > Features > Functions
Posted by "Anonymitaet (via GitHub)" <gi...@apache.org>.
Anonymitaet commented on PR #498:
URL: https://github.com/apache/pulsar-site/pull/498#issuecomment-1495758095
@freeznet @nlu90 thank you!
--
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