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

use cases: broke down into separate files and fixed some headers that… #63

Merged
merged 5 commits into from
Aug 12, 2024

Conversation

silviamazzoni
Copy link
Collaborator

@silviamazzoni silviamazzoni commented Jul 20, 2024

Overview

Broke down Use Cases into separate files and fixed some headers that had not been updated.

Testing

We do need to check the links from the nav because they want to connect to an anchor, not a file, which is how they are set up now.

UI

since TACC-Docs v0.10
since.tacc-docs.v0100.-.click.triangle.mov
since.tacc-docs.v0100.-.click.text.mov
using TACC-Docs v0.8 sample document header
sample.document.navbar.mov
detailed nav is automatically open
detailed.nav.is.automatically.open.mov

edited by @wesleyboar (organized and added visuals)

… had not been updated.

We do need to check the links from the nav because they want to connect to an anchor, not  a file, which is how they are set up now.
Copy link

netlify bot commented Jul 20, 2024

Deploy Preview for ds-user-guide failed. Why did it fail? →

Name Link
🔨 Latest commit ce7eec5
🔍 Latest deploy log https://app.netlify.com/sites/ds-user-guide/deploys/669b057cf3b5d800082b8341

@wesleyboar wesleyboar removed the request for review from susanunit July 25, 2024 15:36
wesleyboar added a commit that referenced this pull request Jul 26, 2024
wesleyboar added a commit that referenced this pull request Jul 26, 2024
wesleyboar added a commit that referenced this pull request Jul 26, 2024
* feat: DES-3045 allow non-flat nav (TACC-Docs 0.10)

* test: DES-3045 use non-flat nav from #63

* Revert "test: DES-3045 use non-flat nav from #63"

This reverts commit 02d8621.

---------

Co-authored-by: Silvia Mazzoni <[email protected]>
@wesleyboar
Copy link
Collaborator

wesleyboar commented Jul 26, 2024

There are navigation bugs when using flat navigation. Reported in DES-3045. Expect solution via TACC-Docs update.

@wesleyboar
Copy link
Collaborator

wesleyboar commented Jul 26, 2024

Tip

If testing via Docker, there are no navigation bugs introduced by this change.

Caution

If testing via Python, several navigation bugs are introduced by this change.

Copy link
Collaborator

@wesleyboar wesleyboar left a comment

Choose a reason for hiding this comment

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

Sort of blocked by #66 because most contributors will not test via Docker.

If you are okay with the nav bugs for Python-based testing, then I'll merge this.

Otherwise, please wait until I have time to solve #66.

@silviamazzoni
Copy link
Collaborator Author

Wes, do you have an update on this?

@wesleyboar
Copy link
Collaborator

No update. Same status as it was in #63 (review). I've been taken by DesignSafe website work and another project. Still an excellent PR. I don't mind it staying open, let's me know what is still waiting on me.

If you are okay with the nav bugs for Python-based testing, please tell and reopen so I can merge. Otherwise, this would wait until have time to solve #66.

@silviamazzoni
Copy link
Collaborator Author

The nav bugs are are only on my testing end, correct?
And they are just style bugs?
The public version of the docs would be perfect and have the separated docs, correct?
If I want to replicate the site locally exactly, I'd have to use the docker, correct?
If so, yes, please accept this PR.

@silviamazzoni silviamazzoni reopened this Aug 12, 2024
@wesleyboar wesleyboar merged commit 7529183 into main Aug 12, 2024
@wesleyboar wesleyboar deleted the silvia/separate-use-cases branch August 12, 2024 17:42
@wesleyboar
Copy link
Collaborator

Yes x4. Merged.

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.

2 participants