Problem/Motivation

After reading the page on https://new.drupal.org/drupalorg/gitlab-custom-commands it is not clear for a new user on how those command should be executed. This leads to a problem where one end up "searching" for the command, which doesn't perform the expected outcome.

Steps to reproduce

Let say you want to execute `/do:access`

- Go to the following url https://git.drupalcode.org/project/drupalorg/-/merge_requests/498
- Start typing `/`
- The focus of the user automatically shifts to the search bar on top. there after typing "do:access" would perform search.

Proposed resolution

Update documentation to explain to the user, these commands are to be performed as "comment" on the issue.

Remaining tasks

- Agree on proposed text for update
- Update https://git.drupalcode.org/project/drupalorg/-/blob/1.0.x/src/Controller...

User interface changes

- N/A

API changes

- N/A

Data model changes

- N/A

Issue fork drupalorg-3591062

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

About issue forks

Comments

d34dman created an issue. See original summary.

d34dman changed the visibility of the branch 3591062-explain-how-to to hidden.

d34dman opened merge request !512

d34dman’s picture

d34dman commented
Status: Active » Needs review

Proposal to add following text

<p>These commands must be posted as a <strong>comment</strong> on the issue or merge request. Typing <code>/<\/code> directly into the GitLab interface (outside of a comment box) will trigger the global search instead.</p>
fjgarlin’s picture

fjgarlin commented

Only on the issue (work item), NOT on the MR.

fjgarlin’s picture

fjgarlin commented
Status: Needs review » Needs work

I also don’t think we need to mention the other types where you don’t need to type since we are mentioning the place where they should, the comment.

d34dman’s picture

d34dman commented
Status: Needs work » Needs review

- Removed the reference to "MR"
- Removed extra info surrounding search

So the text is now as follows,

<p>These commands must be posted as a <strong>comment</strong> on the issue (work item).</p>

fjgarlin’s picture

fjgarlin commented
Status: Needs review » Fixed

I added one more sentence. Merged.

It will go with the next deployment, probably tomorrow.
Thanks.

Now that this issue is closed, review the contribution record.

As a contributor, attribute any organization that helped you, or if you volunteered your own time.

Maintainers, credit people who helped resolve this issue.

  • fjgarlin committed 831cca9a on 1.0.x authored by d34dman 
    task: #3591062 Explain how to execute commands listed on "GitLab custom...

  • fjgarlin committed 831cca9a on modern-sf-membership-sync authored by d34dman 
    task: #3591062 Explain how to execute commands listed on "GitLab custom...