nfdi4plants / web-components

DataPLANT branded web-components for diverse elements. Used in knowledgebase and main pages.
https://nfdi4plants.github.io/web-components-docs/
4 stars 3 forks source link

Dead link to knowledge base #17

Closed Brilator closed 2 years ago

Brilator commented 2 years ago

The knowledge base link in the footer directs to https://nfdi4plants.org/content/docs/research-data-management.html, which does not exist any more (was changed to https://nfdi4plants.org/content/docs/ResearchDataManagement.html...).

Maybe implement a knowledge base landing page and link to that.

Freymaurer commented 2 years ago

Maybe implement a knowledge base landing page and link to that.

@CMR248

Brilator commented 2 years ago

I would suggest to create one single page where the visitor is redirected to when clicking "Knowledge Base" in the Navbar. Just with a few lines introducing what the KB is, incl. sidebar on the left.

Would it make sense to create a new layout: landing for this?

Freymaurer commented 2 years ago

Would it be possible to just imitate the design of web-component-docs? Some documentation repos just start with an Home/Index page.

Brilator commented 2 years ago

Yes, that's perfectly enough. It's really just to have a save and persistent link to the kb.

My suggestion for the landing page (not PR'ed to main, yet): https://github.com/Brilator/nfdi4plants.github.io/blob/main/src/content/docs/landings/landing_knowledgebase.md

Freymaurer commented 2 years ago

It would be awesome if those bold textparts could be actual links to the corresponding subpages!

For a consisting naming, could you change the .md file name to either index.md or home.md?

Brilator commented 2 years ago

It would be awesome if those bold textparts could be actual links to the corresponding subpages!

Yes, but then it gets more complicated for you -> would require additional sub-landing pages for the sections. At the moment those are just drop-down menus.

Brilator commented 2 years ago

For a consisting naming, could you change the .md file name to either index.md or home.md?

Sure

Freymaurer commented 2 years ago

Yes, but then it gets more complicated for you -> would require additional sub-landing pages for the sections. At the moment those are just drop-down menus.

Index pages for sub-categories should not be any different to all other .md files and do not require specific parsing.

See at the example of web-component-docs:

Brilator commented 2 years ago

I understand, I was just trying to say that, the section "heading" itself isn't linked.

Screen Shot 2022-07-07 at 10 10 13

orange arrows: no link blue arrows: link

So, this comes with redundancy (2x "Web Components", 2x "Development") and another level.

Freymaurer commented 2 years ago

Yeah, i imagine it to look something like this for the knowledgebase:

image

Brilator commented 2 years ago

Fine for me.

CMR248 commented 2 years ago

Looks good to me too. It would be great if the outsourced repo could be edited by @Martin-Kuhl, being the main responsible for the KB. So he should at least be listed as maintainer.

Freymaurer commented 2 years ago

Done! 🎉