docs icon indicating copy to clipboard operation
docs copied to clipboard

Help Wanted: Personal access token docs have outdated screenshots

Open svelle opened this issue 2 years ago • 8 comments

Context

The screenshots on the following docs page are outdated and reference menus that don't exist in that state anymore (security/token settings have moved from account to profile options):

https://developers.mattermost.com/integrate/reference/personal-access-token/

Docs request

  • Update the docs page with new product screenshots in PNG format.
  • Review the docs and GitHub code for any other instances of these specific screenshots being outdated.
  • Ensure that ALT text is updated as needed.

How you can help

  • Use the Desktop App, the standard Mattermost Denim theme, and US English for all official docs screenshots.
  • Don't draw arrows, lines, or call outs on screenshot images. (And please don't save and use the screenshots included in this issue. They're here as a guideline.)
  • Replace existing screenshot filenames via /images.

svelle avatar Sep 20 '23 12:09 svelle

2023-09-20_14-13 2023-09-20_14-12 2023-09-20_14-10

here are some screenshots that can be used as a replacement

svelle avatar Sep 20 '23 12:09 svelle

Hi @cwarnermm, I would like to work on the issue, if it is still up for grabs.

aniketh-varma avatar Sep 29 '23 21:09 aniketh-varma

Thank you, @aniketh-varma! We welcome your contribution to this ticket! I've assigned it to you.

cwarnermm avatar Sep 29 '23 21:09 cwarnermm

Hi @cwarnermm, while going through the codebase of the docs repo, I found that the Personal Access Tokens page which is referred to above (https://docs.mattermost.com/developer/personal-access-tokens.html#creating-a-personal-access-token) is residing in the docs/source/archive/personal-access-tokens.rst. Please confirm if I am updating the screenshots in the correct file. Also FYI, I wanted to point out that the content on the page would not match with the updated screenshots.

aniketh-varma avatar Oct 03 '23 18:10 aniketh-varma

Thanks, @aniketh-varma, for investigating further. The docs page in question now lives in the Developer Documentation via https://developers.mattermost.com/integrate/reference/personal-access-token/, rather on the docs site.

The dev docs site is a separate repository in GitHub, and that's where the changes are requested. Please let me know if you have any questions or concerns.

cwarnermm avatar Oct 11 '23 18:10 cwarnermm

@cwarnermm This issue has been idle for a while now. I would love to pick this up. Thanks.

Rutam21 avatar Oct 19 '23 20:10 Rutam21

@aniketh-varma - Please confirm whether you're actively working on this issue. If you're not, that's okay, and we have other contributors interested in picking it up!

cwarnermm avatar Oct 19 '23 20:10 cwarnermm

Hey @cwarnermm, I am working on this issue and will raise a PR soon. Thanks!

aniketh-varma avatar Oct 19 '23 20:10 aniketh-varma

@cwarnermm I would love to take this up and update the screenshot for this page. Feel free to assign this to me. Thanks.

Rutam21 avatar Apr 24 '24 20:04 Rutam21

Thank you, @Rutam21!!

cwarnermm avatar Apr 24 '24 20:04 cwarnermm