You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by "visortelle (via GitHub)" <gi...@apache.org> on 2024/03/01 08:50:56 UTC
[PR] Add "Suggest changes" and "Get support" links [pulsar-site]
visortelle opened a new pull request, #808:
URL: https://github.com/apache/pulsar-site/pull/808
A variation of this PR: https://github.com/apache/pulsar-site/pull/807
<img width="448" alt="Screenshot 2024-03-01 at 12 49 23 PM" src="https://github.com/apache/pulsar-site/assets/9302460/34ffcce2-f73d-4020-bc5d-41acc0d395c6">
Suggest changes -> new GitHub issue with the "Document" template
Get Support -> new GitHub discussion in Q&A section
--
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
Re: [PR] Add "Suggest changes" and "Get support" links [pulsar-site]
Posted by "visortelle (via GitHub)" <gi...@apache.org>.
visortelle commented on PR #808:
URL: https://github.com/apache/pulsar-site/pull/808#issuecomment-1974701743
@jak78 I'll make these fixes in a few days.
--
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
Re: [PR] Add "Suggest changes" and "Get support" links [pulsar-site]
Posted by "jak78 (via GitHub)" <gi...@apache.org>.
jak78 commented on PR #808:
URL: https://github.com/apache/pulsar-site/pull/808#issuecomment-1973066029
Thanks @visortelle
Looks like there are now 2 different paths for people who want to contribute to the docs:
- the 'suggest changes' link that was just added
- the 'Edit' button at the bottom of each page
Moreover, the [homepage of the documentation mentions ](https://pulsar.apache.org/docs/3.2.x/#help-improve-these-documents)a 'landing page with instructions for requesting changes to posted documents.' However, upon clicking the Edit button, no such landing page with explanations is presented.
To streamline the process for those interested in contributing to the documentation, it might be beneficial to offer a single, straightforward path. Wa also need to eliminate references to this nonexistent landing page.
Thoughts?
--
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
Re: [PR] Add "Suggest changes" and "Get support" links [pulsar-site]
Posted by "jak78 (via GitHub)" <gi...@apache.org>.
jak78 commented on PR #808:
URL: https://github.com/apache/pulsar-site/pull/808#issuecomment-1973270309
Thanks for your thoughts. That makes sense to me. Feel free to remove the reference to the non-existing landing page and explain the 2 distinct paths [here](https://pulsar.apache.org/docs/3.2.x/#help-improve-these-documents)
--
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
Re: [PR] Add "Suggest changes" and "Get support" links [pulsar-site]
Posted by "visortelle (via GitHub)" <gi...@apache.org>.
visortelle commented on PR #808:
URL: https://github.com/apache/pulsar-site/pull/808#issuecomment-1973103418
@jak78 I thought about it. Let me explain why I think the additional "Suggest changes" button makes sense.
The "Edit page" button is for someone able and willing to submit a PR. It may require
quite a lot of time.
The "Suggest changes" link is rather for someone who can explain what is wrong with the specific documentation page, but doesn't have enough knowledge or time to submit a PR. I think it would be good to have input from this part of the audience too.
<img width="1303" alt="Screenshot 2024-03-01 at 4 26 24 PM" src="https://github.com/apache/pulsar-site/assets/9302460/e8c0f9f2-62eb-46f1-93e5-a1790df142e9">
--
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
Re: [PR] Add "Suggest changes" and "Get support" links [pulsar-site]
Posted by "visortelle (via GitHub)" <gi...@apache.org>.
visortelle merged PR #808:
URL: https://github.com/apache/pulsar-site/pull/808
--
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
Re: [PR] Add "Suggest changes" and "Get support" links [pulsar-site]
Posted by "visortelle (via GitHub)" <gi...@apache.org>.
visortelle commented on PR #808:
URL: https://github.com/apache/pulsar-site/pull/808#issuecomment-1973225266
Regarding the non-existing “landing page with instructions for requesting changes to posted documents.”, probably it makes sense to remove this sentence.
I like how the "Edit" button works now - opens the page in the online text editor.
--
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
Re: [PR] Add "Suggest changes" and "Get support" links [pulsar-site]
Posted by "visortelle (via GitHub)" <gi...@apache.org>.
visortelle commented on PR #808:
URL: https://github.com/apache/pulsar-site/pull/808#issuecomment-1973230652
Would the “Provide Feedback” link instead of the “Suggest Changes” link make more sense?
--
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