Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
mickmister opened this issue Aug 20, 2021 · 7 comments

Comments

@mickmister
Copy link
Contributor

mickmister commented Aug 20, 2021

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
Copy link
Contributor

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

@cwarnermm
Copy link
Member

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

@cwarnermm cwarnermm changed the title Document the option to use _redirect in place of team name in a post permalink Help Wanted: Document the option to use _redirect in place of team name in a post permalink Jan 27, 2022
@cwarnermm
Copy link
Member

@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 cwarnermm added the Awaiting Submitter Action Blocked on the author label Jan 27, 2022
@mickmister
Copy link
Contributor Author

@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
Copy link
Contributor Author

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
Copy link
Member

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

@mickmister
Copy link
Contributor Author

I'll leave as help wanted for now

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants