Replaced legacy GitBook URLs with PL link #81
Conversation
| @@ -2,7 +2,7 @@ | |||
| "id": "com.mattermost.aws-sns", | |||
| "name": "AWS SNS", | |||
| "description": "Send alert notifications from Amazon AWS CloudWatch to Mattermost channels via AWS SNS.", | |||
| "homepage_url": "https://github.com/mattermost/mattermost-plugin-aws-SNS", | |||
| "homepage_url": "https://mattermost.com/pl/mattermost-plugin-aws-SNS", | |||
There was a problem hiding this comment.
Not sure if we need to change this. The original URL is not a gitbook URL
There was a problem hiding this comment.
Personally I'm thinking this just causes confusion if we change from pointing to the repo to somewhere else. I was under the impression the link would take me to the Mattermost docs site, but it's just a redirect to the repo's readme. As mentioned in the spreadsheet linked in the PR description:
In Yoast because of hash - but since it's an external link doesn't really matter
It seems that it "doesn't matter" if we make this change or not, so I propose we keep it how it is to avoid confusion
There was a problem hiding this comment.
Same for the following PRs:
- Replaced legacy GitBook URLs with PL links mattermost-plugin-circleci#94
- Replaced legacy GitBook URLs with PL links mattermost/mattermost-plugin-gitlab#415
- Replaced legacy GitBook URLs with PL links mattermost/mattermost-plugin-jira#998
Is the plan to relocate some of the information in the readmes to another location?
There was a problem hiding this comment.
Long term, yes. Mattermost-supported plugin README content will likely move back to the product docs site, though a timeline for that work hasn't been set yet. However, that's not driving this change primarily.
These changes were applied to bring Mattermost-supported content in line with our Handbook policy of linking to documentation via permalinks managed by Marketing.
I applied these changes to the in-product text visible via the System Console.
If this change will introduce confusion in the short term, I'm 0/5 on keeping these proposed changes and open to reverting to the GitHub links instead. We could decide to address links if/when we decide to move content in the future.
There was a problem hiding this comment.
If this change will introduce confusion in the short term, I'm 0/5 on keeping these proposed changes and open to reverting to the GitHub links instead. We could decide to address links if/when we decide to move content in the future.
Thanks for the explanation @cwarnermm 👍
Yes I think I would prefer this for now. @hanzei Thoughts on this?
There was a problem hiding this comment.
I'm 1/5 that we don't need perma links here. We can always release a new plugin version if we really want to change a link. I don't think it's worth the confusion.
There was a problem hiding this comment.
Sounds good. Thank you both for your feedback and input. I'll close this PR and the other PRs introducing the same updates, as @mickmister listed above.
|
Holding off on applying this change for the time being based on internal feedback. Closing. |
Replaced absolute GitHub links with permalink via Marketing.
Addresses: https://mattermost.atlassian.net/browse/MM-55436