mattermost / mattermost/mattermost-developer-documentation
Help Wanted: Document the option to use `_redirect` in place of team name in a post permalink
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 90
- Forks
- 460
- Avg merge
- 9d 23h
- Merged PRs (30d)
- 2
Description
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.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the developer documentation section that explains constructing post permalinks, then compare its guidance with the two Mattermost permalink examples in the issue. Done means the documentation explains that _redirect can replace the team name from Mattermost 5.16 onward and why integrations can use it.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100