armada icon indicating copy to clipboard operation
armada copied to clipboard
verified publisher icon armadaproject

SuperTicket: Documentation Changes

Open Sharpz7 opened this issue 2 years ago • 7 comments

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.

  • [x] Fix Broken Link in https://github.com/armadaproject/armada/blob/master/docs/design/relationships_diagram.md (screenshot)
    • [x] https://github.com/armadaproject/armada/pull/2727
  • [x] https://github.com/armadaproject/armada/issues/2492
    • [x] https://github.com/armadaproject/armada/issues/2728
    • [x] https://github.com/armadaproject/armada/issues/2733
  • [ ] https://github.com/armadaproject/armada/issues/2736
  • [x] https://github.com/armadaproject/armada/issues/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 https://github.com/armadaproject/armada/issues/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.
  • [x] https://github.com/armadaproject/armada/issues/2493
  • [ ] https://github.com/armadaproject/armada/issues/2777
  • [ ] https://github.com/armadaproject/armada/issues/1080
  • [x] https://github.com/armadaproject/armada/issues/2833
  • [x] https://github.com/armadaproject/armada/issues/2762

┆Issue is synchronized with this Jira Task by Unito

Sharpz7 avatar Jul 22 '23 20:07 Sharpz7

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

anshgoyalevil avatar Jul 23 '23 06:07 anshgoyalevil

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: https://github.com/armadaproject/armada/pull/2727 Thank you.

Pradeep-Kurapati avatar Jul 23 '23 07:07 Pradeep-Kurapati

@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 :rocket: And let's continue the discussion below that PR only.

anshgoyalevil avatar Jul 23 '23 09:07 anshgoyalevil

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

Pradeep-Kurapati avatar Jul 23 '23 09:07 Pradeep-Kurapati

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

Pradeep-Kurapati avatar Jul 23 '23 11:07 Pradeep-Kurapati

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:

https://github.com/armadaproject/armada/issues/2738 Maybe this is enough to get you started?

Sharpz7 avatar Jul 24 '23 14:07 Sharpz7

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

Pradeep-Kurapati avatar Jul 24 '23 16:07 Pradeep-Kurapati