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

Create a getting started page in the documentation that we can easily reference. #372

Open
magdmartin opened this issue Sep 11, 2024 · 6 comments

Comments

@magdmartin
Copy link
Member

This issue follows the Heuristic Analysis done by asengupta on the forum

Create a getting started page in the documentation that we can easily reference. That page will contain the same information as the updated post-download page (see #371) and can be used by trainers or support personnel as an entry point for new users.

@ViragJain3010
Copy link
Contributor

I'll work on this one too. But honestly, I’m not quite sure what the content on this page is supposed to be. We already have detailed pages for Installation, Running, and Starting a Project. So what exactly will this page add? Will it be more like a quick overview or a simplified guide? Just trying to understand how it fits without overlapping too much with what we already have.

@thadguidry
Copy link
Member

thadguidry commented Dec 24, 2024

From @asengupta the note they had in their Figma was:

Website:
Download thank you page
Next steps section could support onboarding new users more

Possible solutions

  • Add direct links to onboarding resources
    • Documentation
    • Relevant featured documentation (e.g. Installing, Starting a Project)
    • Tutorials list
    • Relevant featured tutorials (e.g. installation, project setup)
  • Reframe community
    • Emphasize support
  • Add sample projects
  • Deprioritize
    • Donating to OpenRefine (likely not good target audience)
    • Extensions list (since not used by many users)
  • Create new “Getting Started” page with above sections that users find easily + refer back to (like Community page)

If you notice, these are all "Possible solutions". The general idea of the Getting Started page was so that it was a single page, that community could link to, and that provided links. But I think you have done that within the Download thank you page, where we might instead have a Getting Started page replacing Introduction in the User Manual, that has links or card items.

My proposal would be to rename "Introduction" as "Getting Started", and then change the paragraph style with tons of links that are easily missed, into nice cards that cover those areas above. If you notice now, our Introduction page actually has all of that and many more links, but it takes a keen eye to read and scan and then click on all those links. I think we can simplify the Introduction page, and make it much less wordy. Just one simple example, a card item for "Troubleshooting", instead of a long sentence and link within it. Generally, the Introduction was seen as beneficial when it was first created, but I think the reality is that it can only be beneficial if easily scanned through, like with card items, instead of long wordy sentences.

@thadguidry
Copy link
Member

Also, I would not even consider an outline as being important in the Getting Started page. Currently, the Introduction page reads through like an outline, but it's entirely not needed in my opinion. We already have an outline, inherent in the hierarchical sidebars that Docusaurus generates.

@ViragJain3010
Copy link
Contributor

ViragJain3010 commented Dec 24, 2024

I completely agree with @thadguidry's suggestions.

Proposed Changes:

  1. Rename Introduction to Getting Started.
  2. Update the Getting Started page to feature cards linking to the resources currently referenced on the Introduction page.
  3. Rename Contributing to OpenRefine to Community.
  4. Rename Getting Started [current path: Contributing to OpenRefine/Getting Started] to Contributing to OpenRefine [updated path: Community/Contributing to OpenRefine], to avoid having two separate "Getting Started" pages.

Additional Suggestions:

  1. Rename Installing to Installation
  2. Rename Running to Starting OpenRefine to make it clearer for users.
  3. Consider renaming Starting a Project to Creating a Project (optional, but it might align better with user expectations).

@thadguidry
Copy link
Member

@magdmartin and others, Your thoughts on @ViragJain3010 suggestions?

@magdmartin
Copy link
Member Author

I'll be able to check this in more detail after Jan 6.

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

No branches or pull requests

3 participants