mattermost-developer-documentation icon indicating copy to clipboard operation
mattermost-developer-documentation copied to clipboard

Help Wanted: Document the option to use `_redirect` in place of team name in a post permalink

Open mickmister opened this issue 4 years ago • 7 comments

Previously we needed to include the team name of the post when constructing a post's permalink. Since Mattermost version 5.16, we can use "_redirect" in place of the team name.

Below are two post permalinks. One has the team name "core" and the other uses "_redirect"

https://community.mattermost.com/core/pl/jcj11chi1pg85jpp8difhsj4eh https://community.mattermost.com/_redirect/pl/jcj11chi1pg85jpp8difhsj4eh

This is useful for integrations because they don't need to fetch the relevant team whenever they want to create some post's permalink.

mickmister avatar Aug 20 '21 16:08 mickmister

This indeed needs to be documented, thanks @mickmister. Can I get help with the file to be modified? (/cc @cwarnermm, @justinegeffen)

haardikdharma10 avatar Oct 03 '21 19:10 haardikdharma10

Great question, @haardikdharma10! I've asked this question in the Mattermost Hacktoberfest 2021 community channel.

cwarnermm avatar Oct 04 '21 12:10 cwarnermm

@mickmister - It's not immediately clear to me where this documentation update would live on developers.mattermost.com. (One thing this site really needs is a search mechanism!) Would you be open to adding details to this PR on the specific page(s) of the site that would benefit most from an update?

cwarnermm avatar Jan 27 '22 13:01 cwarnermm

@cwarnermm I'm thinking we should add a new "Tips and Tricks" page in the "Development Guides" subfolder https://developers.mattermost.com/integrate/admin-guide. This can be the first and only tip on the new page for now 🙂 What do you think?

mickmister avatar Jan 27 '22 18:01 mickmister

Note that this applies to basically all integration types (basically anything that could be creating permalinks to posts). So I would make it something like "When you need to create a permalink to a post..."

mickmister avatar Jan 27 '22 18:01 mickmister

Love it, @mickmister! Are you open to creating the PR for this update?

cwarnermm avatar Jan 27 '22 18:01 cwarnermm

I'll leave as help wanted for now

mickmister avatar Feb 01 '22 08:02 mickmister