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

Get feedback on current new go_refs page #2255

Closed
kltm opened this issue Mar 7, 2024 · 15 comments
Closed

Get feedback on current new go_refs page #2255

kltm opened this issue Mar 7, 2024 · 15 comments

Comments

@kltm
Copy link
Member

kltm commented Mar 7, 2024

As the new page assembly gets put together, we want to make sure that it is acceptable to users.

@kltm
Copy link
Member Author

kltm commented Mar 7, 2024

Will need @pgaudet feedback.

@pkalita-lbl
Copy link
Contributor

pkalita-lbl commented Mar 7, 2024

Some screenshots from my development branch that can be reviewed

Top of page
image

Linked to a specific GO REF (somewhere in the middle of the page)
image

End of page
image

UPDATE: You might notice in the screenshots that plain URLs in the descriptions are not linked. I fixed that after making the screenshots!

@kltm
Copy link
Member Author

kltm commented Mar 11, 2024

Talked to @pgaudet. @pgaudet will reach out to some other users and see what they prefer.

@kltm
Copy link
Member Author

kltm commented Mar 11, 2024

@pgaudet also floated ToC pager, and then linking to individual pages.

@pgaudet
Copy link
Contributor

pgaudet commented Mar 13, 2024

Decision: individual pages + ToC page

@kltm
Copy link
Member Author

kltm commented Mar 13, 2024

Also, there needs to be a link tot SoT (somewhere), so users that want to search through everything can do so. @pgaudet , can you define whether to do this on each page, or just on the ToC.
As well, can you define what you want to see on the ToC? I'm assuming just titles?

@pgaudet
Copy link
Contributor

pgaudet commented Mar 13, 2024

The source of truth (SoT) yaml file is an internal documentation, I propose to put a link in the wiki under the Annotation group documentation. OK ?

@pgaudet
Copy link
Contributor

pgaudet commented Mar 13, 2024

@kltm
Copy link
Member Author

kltm commented Mar 13, 2024

@pgaudet @vanaukenk Noting that this is not yet the SoT and will not be until Patrick's go-ref project is completed. He will do a final sync to re-match things before switching over, but be aware that the old SOP is in place until that happens.

@pkalita-lbl
Copy link
Contributor

Here's a prototype of a basic ToC page:
image

And an individual GO REF page:
image

The "All GO REFs" on the individual GO REF page links back to the ToC page. Let me know if you'd like the ToC page linked from anywhere else, e.g. the header menu. Any other feedback is certainly welcome.

@kltm
Copy link
Member Author

kltm commented Mar 15, 2024

Looks good to me. @pgaudet, do you have any feedback here?

@pgaudet
Copy link
Contributor

pgaudet commented Mar 26, 2024

Looks good.

I have one feature request : to have OBSOLETE refs in a separate section at the bottom.

But if that's complicated we can drop it. Not a requirement for this work.

Thanks, Pascale

@pkalita-lbl
Copy link
Contributor

No that's not complicated at all, will do.

@pgaudet
Copy link
Contributor

pgaudet commented Apr 10, 2024

This seems to be all done? Can this ticket be closed?

@pkalita-lbl
Copy link
Contributor

Yes I'd say so

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

No branches or pull requests

3 participants