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

[DOCS] General improvements - part1 #3645

Merged
merged 13 commits into from
Feb 17, 2025
Merged

[DOCS] General improvements - part1 #3645

merged 13 commits into from
Feb 17, 2025

Conversation

catalinaadam
Copy link
Contributor

PMM-0

Link to the Feature Build: SUBMODULES-0

If this PR adds or removes or alters one or more API endpoints, please review and add or update the relevant API documents as well:

  • API Docs updated

If this PR is related to some other PRs in this or other repositories, please provide links to those PRs:

  • Links to related pull requests (optional).

@catalinaadam catalinaadam changed the title [DOCS] General improvements [DOCS] General improvements - part1 Feb 14, 2025
@BupycHuk BupycHuk added the documentation Documentation changes label Feb 17, 2025
Copy link
Member

@BupycHuk BupycHuk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great Job, just a few small comments

Comment on lines 59 to 66
Steps in the UI:
{.power-number}

1. Go to the main menu and select **Operating System (OS) > Overview**.

2. In the **Node Names** drop-down menu, choose the new node you want to monitor.

3. Modify the time range to view the relevant data for your selected node.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this part seems like it's possible to add node in UI.
especially choose the new node you want to monitor
maybe we should rewrite it like select new node you just registered/installed?
And maybe replace Steps in the UI to How to see monitored node in UI, Find your node in UI or something like that.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated section

@@ -489,6 +489,6 @@ For more information, see [PMM Dashboards](../use/dashboards-panels/index.md).
## Next steps

- [Configure PMM via the interface](../configure-pmm/configure.md)
- [Manage users in PMM](../how-to/manage-users.md)
- [Manage users in PMM](../pmm-admin/manage-users/index.md)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pmm-admin in url confuses me like it's related to pmm-admin tool we have. maybe it should be just "admin" or "administration"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok, I've renamed the folder. Thanks!

Copy link
Member

@ademidoff ademidoff left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One more question: are we sure to drop the Trademark Policy?


![!](../../../images/PMM_External_Serverless_switcher_manually.png)
![!](../../../images/PMM_External_Serverless_switcher_manually.png)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would recommend we set the alt tag to something meaningful rather than leave it empty to honor SEO :)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in this topic, will update all images in another PR with such improvements

@catalinaadam
Copy link
Contributor Author

One more question: are we sure to drop the Trademark Policy?

It was a duplicate topic

@ademidoff ademidoff temporarily deployed to Formatting_issues - pmm-doc-3 PR #3645 February 17, 2025 10:13 — with Render Destroyed
@catalinaadam catalinaadam enabled auto-merge (squash) February 17, 2025 10:16
@catalinaadam catalinaadam merged commit 8e4d04f into v3 Feb 17, 2025
7 checks passed
@catalinaadam catalinaadam deleted the Formatting_issues branch February 17, 2025 10:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants