mattermost / mattermost/mattermost-plugin-confluence

GitBook read-me improvements for installation

Open
#39 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Type/Task
Dominant language
Go
Stars
22
Forks
20
Avg merge
22h 2m
Merged PRs (30d)
1

Description

We should consider making the following changes to clarify the installation process in the GitBook

A. On server when directing users to managing applications Settings > Apps > Manage Apps Should say Settings > Atlasian Marketplace > Manage Apps.

B. On server install there is a step for: Choose Settings at the bottom of the page, enable development mode, and apply the change. Development mode allows you to install apps from outside of the Atlassian Marketplace.
This is not applicable to server instances and no such change is needed for the installation. Please remove.

C. On Server install the following steps are listed:
1. Upload the OBR file you downloaded earlier.
2. Once the app is installed, press Configure to open the configuration page.

Please add info to step 1. explicitly telling not to add my from URL yet in this modal. Since I've already seen this value earlier it is confusing to me if I should just save it in the field along with the uploaded file.

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

The issue identifies the GitBook installation documentation as the entry point; find the server-install section and compare steps A–C against the current text. Update the Apps path, remove the development-mode instruction, and clarify that the From URL field should remain empty during OBR upload. Done means all three requested corrections are visible in the published installation guide.

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
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.