ROCm / rocprofiler-compute

Advanced Profiling and Analytics for AMD Hardware
https://rocm.docs.amd.com/projects/omniperf/en/latest/
MIT License
135 stars 49 forks source link

Docs: refactor and integrate into ROCm docs portal #362

Closed peterjunpark closed 3 months ago

peterjunpark commented 5 months ago

This PR aligns Omniperf's documentation with other ROCm components for publication on rocm.docs.amd.com.

peterjunpark commented 3 months ago

still some formatting issues to fix. Mostly in Profiling by example and Performance model

peterjunpark commented 3 months ago

demo: https://advanced-micro-devices-demo--362.com.readthedocs.build/projects/omniperf/en/362/

coleramos425 commented 3 months ago

Could we land this on dev before upstreaming to main? This way we're being consistent with Contributing.md and we can include these with other bug fixes for the next release.

skyreflectedinmirrors commented 3 months ago

I don't see the performance model in the demo link?

peterjunpark commented 3 months ago

I don't see the performance model in the demo link?

My bad -- fixed.

skyreflectedinmirrors commented 3 months ago

No worries, I'm about halfway through -- have a few comments but it's mostly looking very good

peterjunpark commented 3 months ago

@skyreflectedinmirrors Thanks for the feedback ❤️. Everything you pointed out has been addressed. Pls let me know if there are any other glaring issues.

Also, what's the plan for the old version of the docs? Should we archive them or straight up remove them?

We need to get this into the release branch sooner rather than later.

skyreflectedinmirrors commented 3 months ago

@skyreflectedinmirrors Thanks for the feedback ❤️. Everything you pointed out has been addressed. Pls let me know if there are any other glaring issues.

Also, what's the plan for the old version of the docs? Should we archive them or straight up remove them?

We need to get this into the release branch sooner rather than later.

Thanks for all your quick edits @peterjunpark. My 2 cents is to archive the old docs for a release or two, and then add a redirect from the old site to the new one (if it's going to be a different URL, anyways). But I'd be interested in what @coleramos425 has to say

coleramos425 commented 3 months ago

Thanks for all your quick edits @peterjunpark. My 2 cents is to archive the old docs for a release or two, and then add a redirect from the old site to the new one (if it's going to be a different URL, anyways). But I'd be interested in what @coleramos425 has to say

Agreed. In the current dev branch we have a subdirectory (omniperf/src/archive/docs-x.x) such that the docs workflow will build archived versions of our docs (e.g. accommodating customers with older hyperlinks).

Feel free to move the directory around as you see fit @peterjunpark, but we should probably move the old docs in here and build this version of the docs from the archive subdirectory in a similar fashion.

peterjunpark commented 3 months ago

Thanks for all your quick edits @peterjunpark. My 2 cents is to archive the old docs for a release or two, and then add a redirect from the old site to the new one (if it's going to be a different URL, anyways). But I'd be interested in what @coleramos425 has to say

Agreed. In the current dev branch we have a subdirectory (omniperf/src/archive/docs-x.x) such that the docs workflow will build archived versions of our docs (e.g. accommodating customers with older hyperlinks).

Feel free to move the directory around as you see fit @peterjunpark, but we should probably move the old docs in here and build this version of the docs from the archive subdirectory in a similar fashion.

@coleramos425 @skyreflectedinmirrors Done in 8480640, 85c27a8, and 13c64b2.

Moved it to docs/archive/docs-2.x alongside docs/archive/docs-1.x. Updated workflows and Sphinx confs accordingly.

The archived docs build seems to work fine for me. LMK if there are any concerns. Thanks.