Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature Request: Add 'Help' or 'Documentation' Button to Argus #555

Open
timtimb0t opened this issue Dec 20, 2024 · 1 comment
Open

Feature Request: Add 'Help' or 'Documentation' Button to Argus #555

timtimb0t opened this issue Dec 20, 2024 · 1 comment
Assignees

Comments

@timtimb0t
Copy link

This button should guide users to documentation that explains key processes, such as creating and configuring Jenkins jobs.
It will improve user experience by providing easy access to relevant documentation directly from the service interface and enable users to quickly understand and execute critical tasks like setting up Jenkins jobs and configuring them appropriately.

  • Requirements:
    Add a 'Help' or 'Documentation' button prominently on the service interface.
    Link the button to an existing document (provided) that details the steps for creating and configuring Jenkins jobs.

  • Scope:
    Initial implementation should link to the Jenkins job creation guide.
    Provide a clear and user-friendly way to update or extend the list of linked documentation as more resources become available (already discussed with Alexey)

  • Design Considerations:
    The button should be accessible and intuitive to locate.
    Clearly labeled (e.g., "Help" or "Documentation").

  • Benefits:
    Simplifies onboarding for new users.
    Reduces repetitive queries about common tasks.
    Encourages self-service troubleshooting and setup.

The document is ready to be linked, and there is potential for future expansion as more documentation becomes available.

@fruch
Copy link
Contributor

fruch commented Dec 31, 2024

can you elaborate what are those key processes talking about ? let list those thing you as a new user didn't know or didn't found easily.

you mention here "creating and configuring Jenkins jobs", i.e it's information I would assume should be documented in SCT, not argus, or you mean how to clone job ?

not sure using Argus as a hub for documentation makes lots of sense, why not just use notion page to collect those references ?

if we are talking about Argus own feature, that a bit different, and can be embedded into the Argus ui, but I would start with tooltip across the board with description of each button functionality (and links if needed)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants