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 tags to organize Glossary and Tutorials #1107

Open
honzajavorek opened this issue Jul 23, 2024 · 2 comments
Open

Use tags to organize Glossary and Tutorials #1107

honzajavorek opened this issue Jul 23, 2024 · 2 comments
Labels
t-academy Issues related to Web Scraping and Apify academies.

Comments

@honzajavorek
Copy link
Collaborator

I did a proof of concept and the good news is that Docusaurus tags are easy to use:

Screenshot 2024-07-23 at 7 54 35 Screenshot 2024-07-23 at 7 54 45

Screenshot 2024-07-23 at 07-55-02 One doc tagged with Concepts Apify Documentation

The bad news is that if we want anything else, like listing relevant tags and their pages on the glossary or tutorials homepage, it requires quite some amount of engineering:

@honzajavorek honzajavorek added the t-academy Issues related to Web Scraping and Apify academies. label Jul 23, 2024
@honzajavorek
Copy link
Collaborator Author

Moving from internal chat:

@TC-MO: So the question would be if default behaviour is enough. If not whether all the work spent on custom setup is worth it over default behaviour ?

The default behavior is nice, but I see these problems:

  • I'd like to use the tags at both glossary and tutorials. But I don't want to mix those two, I still want them in separate sections (how-to guides and explanations, according to Diátaxis). That is no problem as we could just use different tags in both.
  • Then both glossary and tutorials need something like landing page, where I'd like to have something like an overview of what tags (relevant just to glossary or tutorials) are available and what articles are inside.
  • If we have that, I'd remove the categories and the whole left panel altogether from glossary and tutorials. The tags would be the main means of navigation for those two top-down, and breadcrumbs would navigate users bottom-up. I don't think the left panel is useful for users as they either come to these sections of the website by a link or search. Nobody is going to browse these like a book, from start to end.

This would be my idea, but given how hard can be to set up the landing page, it's definitely good to ask whether it's worth it.

@honzajavorek
Copy link
Collaborator Author

honzajavorek commented Jul 23, 2024

Maybe there's a way to use the built-in system in a way that it fits what I have in mind? E.g. we could tag all pages in tutorials by their topics, but also by „Tutorials“ and everything in Glossary as „Glossary“. Then these two would have listing pages.

Those wouldn't be the best landing pages in the world, but as a compromise maybe we could link them from the menu… But then still, there's zero built-in customization of the text on that particular tag listing page, and so on.

@honzajavorek honzajavorek changed the title Use tags to organize glossary and tutorials Use tags to organize Glossary and Tutorials Jul 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
t-academy Issues related to Web Scraping and Apify academies.
Projects
None yet
Development

No branches or pull requests

1 participant