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/06/08 08:40:58 UTC
[GitHub] [pulsar] momo-jun opened a new pull request, #15975: [improve][doc][do-not-merge] Information architecture redesigns and changes for Functions
momo-jun opened a new pull request, #15975:
URL: https://github.com/apache/pulsar/pull/15975
### Motivation
As one (Phase1) of the actions to improve the doc set of Pulsar Functions, the motivation is to provide Pulsar users with a more user-centric, accurate, and comprehensive information experience.
Related PR: #15389
### Modifications
1. Re-org topics (concept/task/reference) and layer sub-topics in the left navigation with added .md files.
2. Refactor the content to make it easy to understand.
3. Fix outdated information and errors in original docs.
4. Update cross-ref links due to topic ID changes.
The preview looks good.
Will attach screenshots later...
### 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] Anonymitaet commented on pull request #15975: [improve][doc] Information architecture redesigns and changes for Functions
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on PR #15975:
URL: https://github.com/apache/pulsar/pull/15975#issuecomment-1158696345
@momo-jun some images are PNG while others are SVG. Do you want to keep consistent and use SVG only?
We talked about this before, SVG is better than PNG:
- Adaptive
They adapt to the different sizes of the Chrome windows automatically.
- Sharper and smaller
SVG images are more crisp and clean, and they are in a smaller size.
- Quality
SVG is vector-based and can expand to any size without losing resolution
- Accessibility
SVG is XML-based, and can be read by both human readers and machines like search engines
--
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] github-actions[bot] commented on pull request #15975: [improve][doc][do-not-merge] Information architecture redesigns and changes for Functions
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on PR #15975:
URL: https://github.com/apache/pulsar/pull/15975#issuecomment-1149642465
@momo-jun:Thanks for your contribution. For this PR, do we need to update docs?
(The [PR template contains info about doc](https://github.com/apache/pulsar/blob/master/.github/PULL_REQUEST_TEMPLATE.md#documentation), which helps others know more about the changes. Can you provide doc-related info in this and future PR descriptions? Thanks)
--
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 #15975: [improve][doc][do-not-merge] Information architecture redesigns and changes for Functions
Posted by GitBox <gi...@apache.org>.
momo-jun commented on PR #15975:
URL: https://github.com/apache/pulsar/pull/15975#issuecomment-1157362563
Hi @freeznet @nlu90, if you have reviewed the google docs, you can sign off the PR. 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] github-actions[bot] commented on pull request #15975: [improve][doc][do-not-merge] Information architecture redesigns and changes for Functions
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on PR #15975:
URL: https://github.com/apache/pulsar/pull/15975#issuecomment-1154604021
@momo-jun Please provide a correct documentation label for your PR.
Instructions see [Pulsar Documentation Label Guide](https://docs.google.com/document/d/1Qw7LHQdXWBW9t2-r-A7QdFDBwmZh6ytB4guwMoXHqc0).
--
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 #15975: [improve][doc] Information architecture redesigns and changes for Functions
Posted by GitBox <gi...@apache.org>.
momo-jun commented on PR #15975:
URL: https://github.com/apache/pulsar/pull/15975#issuecomment-1158699019
> @momo-jun some images are PNG while others are SVG. Do you want to keep consistent and use SVG only?
>
> We talked about this before, SVG is better than PNG:
>
> * Adaptive
> They adapt to the different sizes of the Chrome windows automatically.
> * Sharper and smaller
> SVG images are more crisp and clean, and they are in a smaller size.
> * Quality
> SVG is vector-based and can expand to any size without losing resolution
> * Accessibility
> SVG is XML-based, and can be read by both human readers and machines like search engines
Yes, I plan to revamp these PNG files in Phase2. They are reused from existing materials and not aligned with our style.
--
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 merged pull request #15975: [improve][doc] Information architecture redesigns and changes for Functions
Posted by GitBox <gi...@apache.org>.
Anonymitaet merged PR #15975:
URL: https://github.com/apache/pulsar/pull/15975
--
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] github-actions[bot] commented on pull request #15975: [improve][doc][do-not-merge] Information architecture redesigns and changes for Functions
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on PR #15975:
URL: https://github.com/apache/pulsar/pull/15975#issuecomment-1149643911
@momo-jun:Thanks for providing doc info!
--
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