mattermost / mattermost-developer-documentation

Mattermost developer documentation.
https://developers.mattermost.com
BSD 3-Clause "New" or "Revised" License
80 stars 400 forks source link

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

Open mickmister opened 3 years ago

mickmister commented 3 years ago

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.

haardikdharma10 commented 3 years ago

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

cwarnermm commented 3 years ago

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

cwarnermm commented 2 years ago

@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?

mickmister commented 2 years ago

@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 commented 2 years ago

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..."

cwarnermm commented 2 years ago

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

mickmister commented 2 years ago

I'll leave as help wanted for now