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 docs #2

Merged
merged 33 commits into from
Oct 17, 2024
Merged

Update branding in docs #2

merged 33 commits into from
Oct 17, 2024

Conversation

dgaliffiAMD
Copy link
Collaborator

No description provided.

@dgaliffiAMD dgaliffiAMD requested review from a team and jrmadsen as code owners September 29, 2024 03:57
@dgaliffiAMD dgaliffiAMD marked this pull request as draft September 29, 2024 04:29
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.

Just a few small things I noticed and a few suggestions. It'll probably be easier to review when there is a read the docs build available, but it looks you got all the changes.

docs/index.rst Show resolved Hide resolved
docs/index.rst Outdated Show resolved Hide resolved
docs/conceptual/data-collection-modes.rst Outdated Show resolved Hide resolved
docs/conceptual/rocprof-sys-feature-set.rst Show resolved Hide resolved
docs/doxygen/Doxyfile Show resolved Hide resolved
docs/how-to/configuring-runtime-options.rst Show resolved Hide resolved
docs/install/quick-start.rst Outdated Show resolved Hide resolved
@peterjunpark
Copy link
Contributor

peterjunpark commented Oct 4, 2024

Closing and reopening to enable RTD demo build for wysiwyg

@peterjunpark peterjunpark reopened this Oct 4, 2024
@amd-jnovotny
Copy link
Contributor

I looked things over in the RTD build and things seemed good. Just one additional comment (the file wasn't updated so I couldn't comment directly) ... I see the license has Copyright © 2022, but I think if we're renaming the component, we should update that to 2024.

@dgaliffiAMD
Copy link
Collaborator Author

I looked things over in the RTD build and things seemed good. Just one additional comment (the file wasn't updated so I couldn't comment directly) ... I see the license has Copyright © 2022, but I think if we're renaming the component, we should update that to 2024.

Which file is that coming from? I'll update it.

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.

Updates for Metadata headers

docs/conceptual/rocprof-sys-feature-set.rst Outdated Show resolved Hide resolved
docs/how-to/configuring-runtime-options.rst Outdated Show resolved Hide resolved
docs/how-to/configuring-validating-environment.rst Outdated Show resolved Hide resolved
docs/how-to/general-tips-using-rocprof-sys.rst Outdated Show resolved Hide resolved
docs/how-to/instrumenting-rewriting-binary-application.rst Outdated Show resolved Hide resolved
docs/install/quick-start.rst Outdated Show resolved Hide resolved
docs/reference/development-guide.rst Outdated Show resolved Hide resolved
docs/reference/rocprof-sys-glossary.rst Outdated Show resolved Hide resolved
docs/tutorials/video-tutorials.rst Outdated Show resolved Hide resolved
docs/what-is-rocprof-sys.rst Outdated Show resolved Hide resolved
@amd-jnovotny
Copy link
Contributor

I looked things over in the RTD build and things seemed good. Just one additional comment (the file wasn't updated so I couldn't comment directly) ... I see the license has Copyright © 2022, but I think if we're renaming the component, we should update that to 2024.

Which file is that coming from? I'll update it.

It gets picked up from the LICENSE file in the root GitHub directory.

@dgaliffiAMD
Copy link
Collaborator Author

I looked things over in the RTD build and things seemed good. Just one additional comment (the file wasn't updated so I couldn't comment directly) ... I see the license has Copyright © 2022, but I think if we're renaming the component, we should update that to 2024.

Which file is that coming from? I'll update it.

It gets picked up from the LICENSE file in the root GitHub directory.

Okay. I caught that update here: #4

@dgaliffiAMD dgaliffiAMD marked this pull request as ready for review October 7, 2024 20:13
@amd-jnovotny
Copy link
Contributor

@dgaliffiAMD : I think the RTD builds are failing due to this error:

error: source '../../source/lib/rocprof-sys-user' is not a readable file or directory... skipping.
(warning treated as error, aborting now)
https://readthedocs.com/projects/advanced-micro-devices-rocprofiler-systems/builds/2533547/

@dgaliffiAMD
Copy link
Collaborator Author

@dgaliffiAMD : I think the RTD builds are failing due to this error:

error: source '../../source/lib/rocprof-sys-user' is not a readable file or directory... skipping. (warning treated as error, aborting now) https://readthedocs.com/projects/advanced-micro-devices-rocprofiler-systems/builds/2533547/

There will be a dependency on #4 being merged first. I'm just trying to parallelize things. :)

@dgaliffiAMD
Copy link
Collaborator Author

@dgaliffiAMD : I think the RTD builds are failing due to this error:
error: source '../../source/lib/rocprof-sys-user' is not a readable file or directory... skipping. (warning treated as error, aborting now) https://readthedocs.com/projects/advanced-micro-devices-rocprofiler-systems/builds/2533547/

There will be a dependency on #4 being merged first. I'm just trying to parallelize things. :)

@amd-jnovotny, PR4 has been merged, so I'm rebasing this PR. This should hopefully fix the links.

@amd-jnovotny
Copy link
Contributor

@dgaliffiAMD : It looks like docs still aren't working after PR #4 was merged. Is there something else that's needed?

@dgaliffiAMD dgaliffiAMD reopened this Oct 16, 2024
amd-jnovotny
amd-jnovotny previously approved these changes Oct 17, 2024
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 overall. I noticed a few stray omni references in help options, descriptions, and so forth, in addition to one omniperf reference. Those might not have changed, but I thought I would point them out.

docs/install/install.rst Outdated Show resolved Hide resolved
docs/how-to/configuring-runtime-options.rst Outdated Show resolved Hide resolved
docs/how-to/performing-causal-profiling.rst Show resolved Hide resolved
docs/how-to/profiling-python-scripts.rst Show resolved Hide resolved
amd-jnovotny
amd-jnovotny previously approved these changes Oct 17, 2024
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.

@dgaliffiAMD
Copy link
Collaborator Author

Sorry. Some of your keyword suggestions were hidden. I just added them.

@dgaliffiAMD dgaliffiAMD merged commit 032d39f into amd-staging Oct 17, 2024
5 of 7 checks passed
@dgaliffiAMD dgaliffiAMD deleted the dgaliffi/update-docs branch October 17, 2024 19:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants