feat: show markdown help for missing token
Adds 'Show Help' to the error dialog that is shown when gitlab_service
cannot find a token.
Clicking 'Show Help' opens a markdown preview of docs/user/access-token.md
:
This is done by un-excluding docs/user/**
- so that user docs are included in the published extension - and using context.extensionUri
to get a URI for the extension root, which can be used to open packaged files.
Merge request reports
Activity
Thank you for your contribution to GitLab. We believe that everyone can contribute and contributions like yours are what make GitLab great!
- Our Merge Request Coaches will ensure your contribution is reviewed in a timely manner*.
- You can comment
@gitlab-bot label ~"group::"
to add a group label. - After a few days, feel free to ask
@gitlab-bot help
or ping a Merge Request Coach. - Read more how to get help.
This message was generated automatically. You're welcome to improve it.
added Community contribution label
added 1 commit
- 7a0f85f0 - feature: show markdown help for missing token
Hi @aqualls, please review this documentation Merge Request.
added documentation twtriaged labels
- Resolved by Ethan Reesor
@viktomas WDYT? I just copy-pasted the contents of the README's setup section. I'm not happy having two copies of the same thing that would need to be maintained in parallel. One option would be removing the Setup section from the README and linking to the separate document. VSCE can be told how to handle relative URLs in the README, such that the extension page on the marketplace would link to the right place.
IMO a better solution than showing a markdown preview would be creating a walkthrough, as in #419. But that can happen later, as it will take a lot more thought than writing (or copying) some markdown.
If you like this, once !321 (merged) is merged, I'll do something similar for the browsing a remote repository docs and the other URI errors.
Edited by Ethan Reesor
I'll sit tight until we hear from @viktomas on the decision of where the info should live. @firelizzard you are right to raise a concern - two copies violates our expectation of a single source of truth.
assigned to @firelizzard
added 1st contribution label
added sectiondev label
- Resolved by Tomas Vik (OOO back on 2025-02-24)
- Resolved by Ethan Reesor
- Resolved by Ethan Reesor
added 8 commits
-
b7d54640...565b957a - 7 commits from branch
gitlab-org:main
- e2c7f8fd - feat: show markdown help for missing token
-
b7d54640...565b957a - 7 commits from branch
- Resolved by Ethan Reesor
- Resolved by Ethan Reesor
@firelizzard @viktomas Proposed a grammar fix to the messages. Otherwise
👍🏻 from me.added UI text tw-weight3 twfinished labels and removed twtriaged label
removed review request for @aqualls
- Resolved by Ethan Reesor
- Resolved by Ethan Reesor
- Resolved by Ethan Reesor
- Resolved by Tomas Vik (OOO back on 2025-02-24)
- Resolved by Ethan Reesor
- Resolved by Tomas Vik (OOO back on 2025-02-24)
- Resolved by Ethan Reesor
- Resolved by Ethan Reesor
mentioned in issue create-stage#12872 (closed)
- Resolved by Tomas Vik (OOO back on 2025-02-24)
- Resolved by Tomas Vik (OOO back on 2025-02-24)
mentioned in merge request !337 (merged)
- Resolved by Ethan Reesor
- Resolved by Ethan Reesor
- Resolved by Ethan Reesor
- Resolved by Ethan Reesor
The code looks good to me
👍 When I tried it locally, the scrolling to the fragment isn't working. Is it working for you @firelizzard ?EDIT: Now it works. I'm not sure why it didn't work when I tested it for the first time.
Edited by Tomas Vik (OOO back on 2025-02-24)
@firelizzard during testing, I found out that we stopped showing the "GitLab Workflow: Cannot make request. GitLab URL for this workspace is set to.." error when refreshing the sidepanel. The reason for that is that we only log the error when we fetch the GitLab version
If we replace
logError
withhandleError
that should fix it.before after Kooha-2021-09-08-16_54_15 Kooha-2021-09-08-16_55_33 Sidenote: My work laptop got stolen and so I now temporarily use Arch, Kooha works well for me for screen recording.
- Resolved by Tomas Vik (OOO back on 2025-02-24)
enabled an automatic merge when the pipeline for 0e3ab94f succeeds
mentioned in commit d60d2c19
Thanks @firelizzard once again :) this is a great improvement in UX and hopefully, we'll be able to add many more
HelpError
s in the future. I'm going to release this MR towards the end of this week. I'll keep you posted🎉 🚀 This feature (MR
333
) has been released today in version3.30.0
. Lot of3
digits today :) Thanks again @firelizzard for working on this🙏 🙌
mentioned in issue gitlab-org/quality/triage-reports#4605 (closed)
mentioned in issue #411 (closed)
mentioned in issue gitlab-com/www-gitlab-com#12500 (closed)
added typemaintenance label