Uploaded image for project: 'Automation Hub'
  1. Automation Hub
  2. AAH-2357

investigate/create proposal for documenting decision making

XMLWordPrintable

    • False
    • Hide

      None

      Show
      None
    • False

      Problem Description: 

      From a retro on 2/27, we discussed "we need better tracking of project decisions, one line changelogs are useless for devs."

      Copying some notes in from the retro:

      • Hub architecture drive (used to use)
      • concerns about too many places where we document info? (e.g. internal wiki, netifly docs site, and 3rd thing?), Take extra step to go from decision log and take it into docs
      • other example https://peps.python.org/
      • suggestion here is not to replace Jira; it's for engineering specific info: code examples, context about decisions, architecture based, etc
      • +1 for markdown, +1 for having some kind of go-to place where every feature has a history of the decisions (jira issues sometimes get closed and replaced, so maybe a seoarate place; google docs tend to accumulate and silently rot)
      • create another repo just for project discussions? and use discussion tab or issues there?

      outcomes:

      • discuss proposal as a team to figure out next steps

        1. image.gif
          image.gif
          0.2 kB

            [AAH-2357] investigate/create proposal for documenting decision making

            Bruno Rocha added a comment -

            Thanks rhn-engineering-lsmola for bringing this up, I will reach to you shane_mcd next week, I am happy to join the existing discussion about this topic.

            Bruno Rocha added a comment - Thanks rhn-engineering-lsmola for bringing this up, I will reach to you shane_mcd next week, I am happy to join the existing discussion about this topic.

            Shane McDonald added a comment -

            Thanks for pinging me here rhn-engineering-lsmola. I agree that we should think about this in the context of the platform. rochacbruno@redhat.com feel free to set up some time for us to chat about this.

            Shane McDonald added a comment - Thanks for pinging me here rhn-engineering-lsmola . I agree that we should think about this in the context of the platform. rochacbruno@redhat.com feel free to set up some time for us to chat about this.

            Ladislav Smola added a comment -

            rochacbruno@redhat.com  We have ADRs now for the internal decisions now. Going forward, @smcdonal@redhat.com is creating an upstream/internal way of doing this (similar to PEP) for the whole Ansible org. So we don't need to do our own investigation here, we should join the process that is being formalized currently.

            Ladislav Smola added a comment - rochacbruno@redhat.com   We have ADRs now for the internal decisions now. Going forward, @ smcdonal@redhat.com is creating an upstream/internal way of doing this (similar to PEP) for the whole Ansible org. So we don't need to do our own investigation here, we should join the process that is being formalized currently.

              Unassigned Unassigned
              hesmith@redhat.com Heather Smith
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

                Created:
                Updated:
                Resolved: