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

Update branding in documentation #442

Merged
merged 20 commits into from
Nov 6, 2024

Conversation

peterjunpark
Copy link
Contributor

@peterjunpark peterjunpark commented Oct 3, 2024

Related: #428

@peterjunpark peterjunpark added the documentation Improvements or additions to documentation label Oct 3, 2024
@peterjunpark peterjunpark force-pushed the docs/rebrand branch 4 times, most recently from 1847c77 to 13a5d65 Compare October 25, 2024 17:16
@peterjunpark peterjunpark marked this pull request as ready for review October 28, 2024 14:33
@peterjunpark peterjunpark requested a review from a team as a code owner October 28, 2024 14:33
docs/index.rst Outdated Show resolved Hide resolved
Import the Omniperf dashboard file
----------------------------------
Import the ROCm Compute Profiler dashboard file
-----------------------------------------------

From the **Create** → **Import** page, upload the dashboard file,
``/dashboards/Omniperf_v{__VERSION__}_pub.json`` from the
Copy link
Contributor

Choose a reason for hiding this comment

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

Should this still reference Omniperf? Might not be updated.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Copy link
Collaborator

Choose a reason for hiding this comment

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

@xuchen-amd , are you renaming these files as a part of a subsequent change or will they keep they're name for now?

Copy link
Contributor

Choose a reason for hiding this comment

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

patch PR created: #469

Copy link
Contributor

@amd-jnovotny amd-jnovotny left a comment

Choose a reason for hiding this comment

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

Looks good now.

@peterjunpark
Copy link
Contributor Author

@amd-jnovotny Thx for catching those

@peterjunpark peterjunpark merged commit 2267075 into ROCm:amd-staging Nov 6, 2024
11 checks passed
@peterjunpark peterjunpark deleted the docs/rebrand branch November 6, 2024 20:32
dgaliffiAMD pushed a commit that referenced this pull request Nov 6, 2024
* find/replace Omniperf to ROCm Compute Profiler

Signed-off-by: Peter Park <[email protected]>

* update name in Sphinx conf

Signed-off-by: Peter Park <[email protected]>

* mv what-is-omniperf.rst -> what-is-rocprof-compute.rst

Signed-off-by: Peter Park <[email protected]>

* update Tutorials section

Signed-off-by: Peter Park <[email protected]>

* add Omniperf as keyword to Conceptual section for internal search

Signed-off-by: Peter Park <[email protected]>

* update Reference section

Signed-off-by: Peter Park <[email protected]>

* black fmt conf.py

Signed-off-by: Peter Park <[email protected]>

* update profile mode and basic usage subsections

Signed-off-by: Peter Park <[email protected]>

* update how to use analyze mode subsection

Signed-off-by: Peter Park <[email protected]>

* update install section

Signed-off-by: Peter Park <[email protected]>

* fix sphinx warnings

Signed-off-by: Peter Park <[email protected]>

* fix cmd line examples in profile/mode.rst

Signed-off-by: Peter Park <[email protected]>

* update install decision tree image

Signed-off-by: Peter Park <[email protected]>

* fix TOC and index

Signed-off-by: Peter Park <[email protected]>

fix weird wording

* fix cli text: deriving rocprofiler-compute metrics...

Signed-off-by: Peter Park <[email protected]>

* update standalone-gui.rst

Signed-off-by: Peter Park <[email protected]>

* restore removed doc updates from #428

Signed-off-by: Peter Park <[email protected]>

* update ref to Omniperf in index.rst

Signed-off-by: Peter Park <[email protected]>

* fix grafana connection name to match image

Signed-off-by: Peter Park <[email protected]>

* update cmds in tutorials

Signed-off-by: Peter Park <[email protected]>

---------

Signed-off-by: Peter Park <[email protected]>
@dgaliffiAMD
Copy link
Collaborator

dgaliffiAMD commented Nov 6, 2024

Cherry picking to #468

dgaliffiAMD pushed a commit that referenced this pull request Nov 8, 2024
* find/replace Omniperf to ROCm Compute Profiler

Signed-off-by: Peter Park <[email protected]>

* update name in Sphinx conf

Signed-off-by: Peter Park <[email protected]>

* mv what-is-omniperf.rst -> what-is-rocprof-compute.rst

Signed-off-by: Peter Park <[email protected]>

* update Tutorials section

Signed-off-by: Peter Park <[email protected]>

* add Omniperf as keyword to Conceptual section for internal search

Signed-off-by: Peter Park <[email protected]>

* update Reference section

Signed-off-by: Peter Park <[email protected]>

* black fmt conf.py

Signed-off-by: Peter Park <[email protected]>

* update profile mode and basic usage subsections

Signed-off-by: Peter Park <[email protected]>

* update how to use analyze mode subsection

Signed-off-by: Peter Park <[email protected]>

* update install section

Signed-off-by: Peter Park <[email protected]>

* fix sphinx warnings

Signed-off-by: Peter Park <[email protected]>

* fix cmd line examples in profile/mode.rst

Signed-off-by: Peter Park <[email protected]>

* update install decision tree image

Signed-off-by: Peter Park <[email protected]>

* fix TOC and index

Signed-off-by: Peter Park <[email protected]>

fix weird wording

* fix cli text: deriving rocprofiler-compute metrics...

Signed-off-by: Peter Park <[email protected]>

* update standalone-gui.rst

Signed-off-by: Peter Park <[email protected]>

* restore removed doc updates from #428

Signed-off-by: Peter Park <[email protected]>

* update ref to Omniperf in index.rst

Signed-off-by: Peter Park <[email protected]>

* fix grafana connection name to match image

Signed-off-by: Peter Park <[email protected]>

* update cmds in tutorials

Signed-off-by: Peter Park <[email protected]>

---------

Signed-off-by: Peter Park <[email protected]>
JeniferC99 pushed a commit that referenced this pull request Nov 18, 2024
* Rename Omniperf to ROCm Compute Profiler (#428)

- Update filenames.
- Update executable to `rocprof-compute`
- Update update package to `rocprofiler-compute`
- Update name in application output and logs
- Update name in README files
- Update testing and workflows

---------

Signed-off-by: Xuan Chen <[email protected]>

* Give executable permission to rocprof-compute (#456)

Signed-off-by: coleramos425 <[email protected]>

* Update VERSION to 3.0.0 (#457)

* Update VERSION  and README to 3.0.0
* Update version mismatch of profiling data to a warning.

Signed-off-by: David Galiffi <[email protected]>

* Fix changelog heading

Signed-off-by: Peter Park <[email protected]>

* External CI: rename pipeline to rocprofiler-compute (#463)

Signed-off-by: Daniel Su <[email protected]>

* Update branding in documentation (#442)

* find/replace Omniperf to ROCm Compute Profiler

Signed-off-by: Peter Park <[email protected]>

* update name in Sphinx conf

Signed-off-by: Peter Park <[email protected]>

* mv what-is-omniperf.rst -> what-is-rocprof-compute.rst

Signed-off-by: Peter Park <[email protected]>

* update Tutorials section

Signed-off-by: Peter Park <[email protected]>

* add Omniperf as keyword to Conceptual section for internal search

Signed-off-by: Peter Park <[email protected]>

* update Reference section

Signed-off-by: Peter Park <[email protected]>

* black fmt conf.py

Signed-off-by: Peter Park <[email protected]>

* update profile mode and basic usage subsections

Signed-off-by: Peter Park <[email protected]>

* update how to use analyze mode subsection

Signed-off-by: Peter Park <[email protected]>

* update install section

Signed-off-by: Peter Park <[email protected]>

* fix sphinx warnings

Signed-off-by: Peter Park <[email protected]>

* fix cmd line examples in profile/mode.rst

Signed-off-by: Peter Park <[email protected]>

* update install decision tree image

Signed-off-by: Peter Park <[email protected]>

* fix TOC and index

Signed-off-by: Peter Park <[email protected]>

fix weird wording

* fix cli text: deriving rocprofiler-compute metrics...

Signed-off-by: Peter Park <[email protected]>

* update standalone-gui.rst

Signed-off-by: Peter Park <[email protected]>

* restore removed doc updates from #428

Signed-off-by: Peter Park <[email protected]>

* update ref to Omniperf in index.rst

Signed-off-by: Peter Park <[email protected]>

* fix grafana connection name to match image

Signed-off-by: Peter Park <[email protected]>

* update cmds in tutorials

Signed-off-by: Peter Park <[email protected]>

---------

Signed-off-by: Peter Park <[email protected]>

* Update webui branding (#459)

* Update name and icon for browser tab to rocprofiler-compute.

Signed-off-by: xuchen-amd <[email protected]>

* Update name and icon for browser tab to rocprofiler-compute.

Signed-off-by: xuchen-amd <[email protected]>

---------

Signed-off-by: xuchen-amd <[email protected]>

* Rename grafana files to RocProfCompute

* Rebranding update

Missed references mostly in comments

---------

Signed-off-by: Xuan Chen <[email protected]>
Signed-off-by: coleramos425 <[email protected]>
Signed-off-by: David Galiffi <[email protected]>
Signed-off-by: Peter Park <[email protected]>
Signed-off-by: Daniel Su <[email protected]>
Signed-off-by: xuchen-amd <[email protected]>
Co-authored-by: xuchen-amd <[email protected]>
Co-authored-by: Cole Ramos <[email protected]>
Co-authored-by: Peter Park <[email protected]>
Co-authored-by: Daniel Su <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants