make it easier to suggest changes to kurl.sh documentation pages
#932
Comments
|
That behavior is intentional. We want it pointing at the core project source code repo vs the project website/docs repo. That matches a pattern of linking to the project's code repo established on our other open-source project landing pages like https://kots.io/ and https://troubleshoot.sh/ What challenge is not pointing to https://github.com/replicatedhq/kurl.sh presenting? For example is it making it harder to know where to edit the docs on kurl.sh? That would help us understand if there's alternative approaches to changing where that button is currently linking. |
|
that was my initial assumption, yes; that View on GitHub would take me to
the source of the docs to suggest a change.
On Wed, Jan 25, 2023 at 4:52 PM Amber Alston ***@***.***> wrote:
That behavior is intentional. We want it pointing at the core project
source code repo vs the project website/docs repo. That matches a pattern
of linking to the project's code repo established on our other open-source
project landing pages like https://kots.io/ and https://troubleshoot.sh/
What challenge is not pointing to https://github.com/replicatedhq/kurl.sh
presenting? For example is it making it harder to know where to edit the
docs on kurl.sh? That would help us understand if there's alternative
approaches to changing where that button is currently linking.
—
Reply to this email directly, view it on GitHub
<#932 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AACHN5R7UH6HFQL5TVHCKZ3WUGODPANCNFSM6AAAAAAUGXFC6U>
.
You are receiving this because you authored the thread.Message ID:
***@***.***>
--
Ada Mancini
Customer Reliability Engineer
Book a meeting with me <http://calendly.com/replicated-ada>
|
|
I don't think it makes it substantially more difficult, but my first
assumption was that I would get to the source of the page.
On Wed, Jan 25, 2023 at 4:56 PM Ada Mancini ***@***.***> wrote:
that was my initial assumption, yes; that View on GitHub would take me to
the source of the docs to suggest a change.
On Wed, Jan 25, 2023 at 4:52 PM Amber Alston ***@***.***>
wrote:
> That behavior is intentional. We want it pointing at the core project
> source code repo vs the project website/docs repo. That matches a pattern
> of linking to the project's code repo established on our other open-source
> project landing pages like https://kots.io/ and https://troubleshoot.sh/
>
> What challenge is not pointing to https://github.com/replicatedhq/kurl.sh
> presenting? For example is it making it harder to know where to edit the
> docs on kurl.sh? That would help us understand if there's alternative
> approaches to changing where that button is currently linking.
>
> —
> Reply to this email directly, view it on GitHub
> <#932 (comment)>,
> or unsubscribe
> <https://github.com/notifications/unsubscribe-auth/AACHN5R7UH6HFQL5TVHCKZ3WUGODPANCNFSM6AAAAAAUGXFC6U>
> .
> You are receiving this because you authored the thread.Message ID:
> ***@***.***>
>
--
Ada Mancini
Customer Reliability Engineer
Book a meeting with me <http://calendly.com/replicated-ada>
--
Ada Mancini
Customer Reliability Engineer
Book a meeting with me <http://calendly.com/replicated-ada>
|
|
That's good feedback. I think it would be a lot easier to make docs improvements on this site if the docs section on kurl.sh had the quick pr/issue link buttons on each page like docs.replicated.com has. There is an open conversation about the future of this kurl.sh site that could change the amount and/or scope of docs content we have on it today. It probably makes sense to make those decisions ahead of investing the time to add quick links or another path to easier kurl.sh docs prs like a secondary "View on Github" button. cc @kyleprice and @replicatedhq/replicated-docs |
|
@AmberAlston thanks! edited the issue title to reflect these thoughts |
adamancini
changed the title
kurl.sh documentation pages
the "View on GitHub" button at the top of https://kurl.sh points to https://github.com/replicatedhq/kurl; it should point to https://github.com/replicatedhq/kurl.sh insteadThe text was updated successfully, but these errors were encountered: