Outreachy Application-Period Engagement: Documentation Inclusivity

[sgoggins]

1. An overview of the project can be found at Potential Outreachy Project: Augur Documentation Inclusivity #328
2. Install Augur (https://github.com/chaoss/augur)
3. Show us a screen shot in this issue that you got it installed (include the screen shot as a comment on this issue)
4. Review the existing documentation at: https://oss-augur.readthedocs.io/en/main/
5. Open an issue or PR to improve Augur documentation. You can edit Augur documentation here: https://github.com/chaoss/augur/tree/main/docs
6. Post your achievements back to the Outreachy application

[jwflory]

On the admin/mentor side, see two example issues from a Fedora Project Outreachy project (example 1, example 2). Including links to helpful documentation and clarifying what "success" looks like is helpful too. For example, a screenshot of what exactly? Should I show it running from the command line, or a GUI? What are the expectations for a newcomer to successfully complete this task?

Related to #312.

[Biki-das]

@sgoggins what do we mean here by install, like for the documentation inclusivity we need to locally run the doc first in a localhost, test our changes , but I did not find any instruction for the same , am I interpreting something wrong?

[Preshh0]

@Biki-das, there's an installation guideline in the docs.

[marv-tech]

Screenshot of Augur installation

[Francoise02]

@Biki-das, there's an installation guideline in the docs.

Hello @Biki-das, I'm also stuck on the installation but I can't see the guide you have mentioned in the docs. Please can you share the exact link to the guide? Thanks in advance :)

[Preshh0]

Hi @Francoise02, this is the one I'm currently using https://oss-augur.readthedocs.io/en/main/quick-start.html.

Although it's still proving difficult to install. What OS are you using?

[Francoise02]

Hello, @Preshh0 Thank you for sharing. Let me check it out! I'm using Microsoft Windows.

[namgyalangmo]

[Preshh0]

[Biki-das]

Applicant Biki das

Augur successfully Installed .

[yashtikajigs]

I have used the Docker method to install augur. Below is the snapshot of the same-

[HarrietAkot]

[HarrietAkot]

[Priya730]

[Biki-das]

hey @DevanshRaizada you are copying my screenshot and posting it as your work? accidental ? please remove it.

[Xaviemille]

[Biki-das]

hey @DevanshRaizada you are copying my screenshot and posting it as your work? accidental ? please remove it.

Sorry attached wrong ss by mistake

hey @DevanshRaizada plz remove it.

[germonprez]

hey @DevanshRaizada you are copying my screenshot and posting it as your work? accidental ? please remove it.

Sorry attached wrong ss by mistake

hey @DevanshRaizada plz remove it.

Has this been resolved?

[Delight362]

[fakeInsights]

Hello All,
This Augur running on Google Colab. Any thoughts and feedback are welcome. Thanks --
This is the start of a PR to improve Augur documentation and broaden inclusivity through a demo that works on Google Colab, a tool that is widely available for free online.

[ElizabethN]

I'm going to close this issue now that the Outreachy deadline has passed.