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

[developer] Installation instructions are difficult to find #115

Closed
Tracked by #47
DanielBelmes opened this issue Feb 7, 2024 · 10 comments · Fixed by #116
Closed
Tracked by #47

[developer] Installation instructions are difficult to find #115

DanielBelmes opened this issue Feb 7, 2024 · 10 comments · Fixed by #116
Assignees
Labels
bug Something isn't working developer Anything related to the Developers section of the documentation website documentation Improvements or additions to documentation

Comments

@DanielBelmes
Copy link
Contributor

Installation instructions are three clicks into Modules. There's no intuitive way to find them. We should either make it a top level category as it's very important. Or we should link it on the index.

@DanielBelmes DanielBelmes added bug Something isn't working documentation Improvements or additions to documentation developer Anything related to the Developers section of the documentation website labels Feb 7, 2024
@heysokam
Copy link
Contributor

heysokam commented Feb 7, 2024

This got a bit buried because of the rework of the manual structuring 🤔

But the problem currently exists because the microsites are closed (and the website is currently in alpha state of what it will become), and the typescript microsite is what should contain those intuitive installation instructions that are so desperately needed, and will also link to the proper section of the manual without having to go click 3 menus to find the instructions buried in the Infrastructure Module.

Also important to note is that new idea for the manual is not to be a first-entry point of information, but rather a source of reference for people who already know their way around the engine and just need the advanced details and information. That, or to be linked to a different section and/or be searched for with the searchbar.

I'm currently working on the typescript tutorial, which has the new oneliner installation for ubuntu, but it was agreed that the Control Center will solve this problem eventually, and the instructions would need to be reworked.
Relevant file: ubuntu installation that also links to those manual pages

@HexaField What do you think we should do with the advanced installation instructions?
Should we keep them as they are, or move them out of where we put them like @DanielBelmes is mentioning?

@heysokam heysokam mentioned this issue Feb 7, 2024
55 tasks
@DanielBelmes
Copy link
Contributor Author

Yup that's alright but we have many people coming to the documentation to look for installation instructions and it has to be visible. It doesn't have to be in the Manual. But for now we should prioritize exposing them in the meantime as we've already had complaints on our discord help channels.

@HexaField
Copy link
Member

It really should be as immediate and obvious as possible

@heysokam
Copy link
Contributor

heysokam commented Feb 8, 2024

@HexaField Where should they be located specifically?
I relied on your design/opinion for the structure of the manual, so I'm not quite sure myself on where it fits well enough for the structure redesign but also to solve this issue.

@HexaField
Copy link
Member

@HexaField Where should they be located specifically? I relied on your design/opinion for the structure of the manual, so I'm not quite sure myself on where it fits well enough for the structure redesign but also to solve this issue.

What if we had another whole section, "Installation", "Manual", "Developer" are whole pages essentially

@heysokam
Copy link
Contributor

heysokam commented Feb 8, 2024

@HexaField Where should they be located specifically? I relied on your design/opinion for the structure of the manual, so I'm not quite sure myself on where it fits well enough for the structure redesign but also to solve this issue.

What if we had another whole section, "Installation", "Manual", "Developer" are whole pages essentially

image
Relevant, as it shows the look of the final navbar
I feel like that would clutter the navbar a lot, which is already quite complex (in the final version, not the one currently exposed) and derail from the Personas site idea a bit
🤔

What about placing it at the root level of the Manual, right next to the other sections?
Maybe even the first one before Concepts, if its so important to warrant a whole micro-site? 🤔

@HexaField
Copy link
Member

i think it's important enough and going to be asked so many times that we should put it in the nav

@heysokam
Copy link
Contributor

heysokam commented Feb 8, 2024

"It's in the manual" and then you find it right there at the top first option sounds intuitive to me, and at the same time doesn't worsen the navbar UX.
But will do that ✍️

@heysokam
Copy link
Contributor

heysokam commented Feb 8, 2024

Completed the PR, but marked it as Draft as I don't think this is creating good UX
#116 (comment)

I fully believe that having a /manual/install section, positioned right above Concepts, and exposing that route to the navbar while the microsites are WIP, is a much better solution to not break the UX that was created with the Personas strategy... than it is to have a full installation microsite.

Lets solve the Discord discussion before merging this in

@heysokam
Copy link
Contributor

heysokam commented Feb 9, 2024

@DanielBelmes The PR should be ready to review/publish with the new changes:
#116 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working developer Anything related to the Developers section of the documentation website documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants