mattermost / mattermost/mattermost-developer-documentation

Help Wanted: Open all external links in a new browser tab

Open
#1,142 11 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Good first issue Help Wanted
Dominant language
CSS
Stars
90
Forks
460
Avg merge
9d 23h
Merged PRs (30d)
2

Description

Problem space
Currently, links to external sites from the Mattermost developer documentation take the visitor away from developers.mattermost.com.

Target audience
All users

Goal

  • Open all external links across the developer documentation site in a new browser tab, rather than the current tab.

Delivery expectations

  • 1 PR with all proposed changes
  • See the Slash commands at Mattermost > Tips and best practices > step #1 API documentation link featured in the developer documentation for an example of the code needed to open external links in new browser tabs
  • Leave all links to other pages of the developer documentation site as-is.
  • Links to the Mattermost Product or API documentation sites count as an external site link and should be updated.
  • Comment in the PR to request a generated preview of your work. The Docs team will add the appropriate labels to your PR.

Tech needed

  • HTML
  • Markdown format
  • Hugo

Affected repository
mattermost/mattermost-developer-documentation

Where to get help
Join the Mattermost Docs team on the Mattermost Community Server in the ~Documentation Working Group channel to discuss this ticket, or feel free to comment in this docs ticket

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the Slash commands Tips and best practices step #1 API link for the existing new-tab example, then inspect the Hugo documentation content for external links. Done means external links, including Mattermost Product and API documentation links, open in a new tab while links within the developer documentation remain unchanged; request a generated preview in the PR.

Written by the indexing model from the issue text.

Assessment

Tech stack
html, hugo, markdown
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.