SuperTicket: Documentation Changes

[Sharpz7]

This Ticket aims to keep track of other tickets of Docs changes, an order or priority for those tickets, and any tickets yet to be created for work that should be completed.

If something does not currently have a ticket, mention me and I can explain the process.

• Fix Broken Link in https://github.com/armadaproject/armada/blob/master/docs/design/relationships_diagram.md (screenshot)
• • Fixed broken link in relationships_diagram.md #2727
• Better Docs on Armada Development for Windows / WSL #2492
• • mage ui not working on Windows OS #2728
• • mage-ui is not using Window's specific arguments for docker run #2733
• Production Guide should be updated to use our operator for installation #2736
• Armada V1 and Armada V2 diagrams #2738
• Change https://github.com/armadaproject/armada/blob/master/docs/design/relationships_diagram.md to better describe what all the components do.
• Ensure that https://armadaproject.io/design links to components diagram to make it easier to find. Also link here at the root of the repo
• A document containing Lookout Handover #2684 as a doc.
• Add to that document the Pulsar Scheduler and its migration requirements.
• Create a more stylised symbol to show the difference between ingesters and other Armada Components.
• Better Docs for running Armada Development on M1/Arm #2493
• Investigate User Docs and how to best utilise them #2777
• Documentation for C# dotnet gRPC client #1080
• Add README for operator/helm #2833
• Port 6443 already in use - kind.yaml #2762

┆Issue is synchronized with this Jira Task by Unito

[anshgoyalevil]

@Sharpz7 I would like to work on some of the child issues under this parent ticker. Can I go ahead and create a PR?

[Pradeep-Kurapati]

Hey @anshgoyalevil, I worked on the broken link issue. It is working in my fork but failing e2e tests after I submitted a pull requests. Can you please help me find what's missing? Here is the pr: #2727
Thank you.

[anshgoyalevil]

@Pradeep-Kurapati I just checked the branch. I couldn't find any failing e2e tests. Could you please elaborate on the issue you are facing a little more? Thanks 🚀
And let's continue the discussion below that PR only.

[Pradeep-Kurapati]

@anshgoyalevil There are no failed tests now. I don't know why, after sometime, the '❌' disappeared. Thanks for checking tho.

[Pradeep-Kurapati]

@Sharpz7 can you provide any references for making V1 Armada vs V2 Armada diagrams? Thank you.

[Sharpz7]

Hey @Pradeep-Kurapati. That is not 100% straight forward right now. I will get back to you when I can. See if one of the other sub-tickets needs working on :))

Update:

#2738 Maybe this is enough to get you started?

[Pradeep-Kurapati]

Hey @Sharpz7, I would like to work on it. Could you please assign me?