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

fix: update links in header and footer #87

Merged
merged 11 commits into from
Apr 12, 2023
Merged

fix: update links in header and footer #87

merged 11 commits into from
Apr 12, 2023

Conversation

samjwu
Copy link
Member

@samjwu samjwu commented Apr 11, 2023

also adds alpha watermark

@samjwu samjwu self-assigned this Apr 11, 2023
@samjwu samjwu changed the title fix - update links in header and footer fix: update links in header and footer Apr 11, 2023
@saadrahim
Copy link
Member

Can we have a preview link?

pyproject.toml Outdated Show resolved Hide resolved
@samjwu
Copy link
Member Author

samjwu commented Apr 11, 2023

Can we have a preview link?

https://rocmdocs.amd.com/projects/alpha/en/rtd/

The static content is obtained from the main branch, so the watermark won't appear until this is merged

Copy link
Contributor

@Maetveis Maetveis left a comment

Choose a reason for hiding this comment

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

A few suggestion, overall lgtm.

Some notes on commit prefixes:

  • docs is for the projects own documentation, i.e. changes that only affect this projects docs most of the changes in this PR should be feat:
  • IMO reverting should either be in git revert style Revert "<original commit>" or with the type revert: (I would prefer option 1)

Any change that results in downstream changes should be "feat" or "fix", with breaking changes noted when required, as these are the only prefixes that trigger a new version number.

docs/.gitignore Outdated
Comment on lines 3 to 5
/_images
/_static
/_templates
Copy link
Contributor

Choose a reason for hiding this comment

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

Building the docs should no longer generate these, that's why I removed them from the ignore list.
If you just delete them from your working tree then they shouldn't come back.

Copy link
Member Author

Choose a reason for hiding this comment

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

Removed in c479e7b

.gitignore Outdated
@@ -4,3 +4,4 @@ dist/**/*
**/__pycache__/**/*
**/*.egg-info/**/*
.sass-cache/*
build
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
build
/build

We don't want it applied to sub folders containing build. Btw what creates this folder?

Copy link
Member Author

Choose a reason for hiding this comment

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

Done in c479e7b

This gets built when I install a local version of rocm-docs-core for testing via pip install <dir>/rocm-docs-core

preserveAspectRatio="xMidYMid meet">

<g transform="translate(0.000000,77.000000) scale(0.100000,-0.100000)"
fill="#000000" stroke="none">
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
fill="#000000" stroke="none">
fill="#a0a0a0" stroke="none">

Tweaking this to mid-gray and adjusting the opacity to 20% makes the watermark also visible on the dark theme.

Copy link
Member Author

Choose a reason for hiding this comment

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

Looks good. Changes made in 7ccebb9

@samjwu
Copy link
Member Author

samjwu commented Apr 12, 2023

A few suggestion, overall lgtm.

Some notes on commit prefixes:

* docs is for the projects **own** documentation, i.e. changes that only affect this projects docs most of the changes in this PR should be `feat:`

* IMO reverting should either be in `git revert` style `Revert "<original commit>"` or with the type `revert: ` (I would prefer option 1)

Any change that results in downstream changes should be "feat" or "fix", with breaking changes noted when required, as these are the only prefixes that trigger a new version number.

I have rebased and edited the commit messages to match.

@samjwu samjwu merged commit 96d9a10 into ROCm:develop Apr 12, 2023
@samjwu samjwu deleted the fix branch April 12, 2023 20:34
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