Move Developer Process Docs to repo1 bigbang repository

Developer documentation should reside in Repo1 where people without confluence can access it.

changed milestone to %1.2.0

added kinddocs + 1 deleted label

assigned to @Ozzie100

@runyontr What developer process docs do we have that are not related to how the Big Bang team operates from a logistical perspective?

I am assuming the 5 pronged Rob K. https://jira.il2.dso.mil/browse/BB-747 Jira Epic will cover all of the necessary docs except for the team logistics?

If this is just BB team logistics, any thoughts on structure or use of the wiki?

@Ozzie100, we are talking about the developer onboarding documentation that you asked us to create. It was temporarily created in Confluence
https://confluence.il2.dso.mil/display/BB1/Contribution+and+Development+Guide+for+Packages
I like the idea of using the Wiki. It will be much easier to keep the documentation updated in the wiki rather than as a markdown document in the actual bigbang code. The Wiki does not need merge request but still keep the history.
That is how I will proceed. Unless someone has an objection.

mentioned in merge request !121 (closed)

Wiki started here
https://repo1.dso.mil/platform-one/big-bang/bigbang/-/wikis/home

Finished
https://repo1.dso.mil/platform-one/big-bang/bigbang/-/wikis/developer/developer-documentation this issue can be closed

added 1 deleted label

@kevin.wilder we need to move this to the gitlab repo so it can be:

• easily found. The largest complaint about the current documentation is that different pieces are in different places. We need to standardize and consolidate the documentation into one location.
• updated as code changes in the repo. Wiki's (e.g. Confluence) get out of date too easily because they're not co-located with the things changing.

Multiple sources of documentation in various places are a huge challenge both for discoverability and maintainability.

added 1 deleted label and removed 1 deleted label

1. I would argue that this is not customer information. This is developer process information. Customers don't need to see this and it would just add more confusion and questions.
2. A Wiki is very easy to keep updated. Updates can be made instantly in Wiki on the fly. Documentation in the code takes a merge request to update it. Too much trouble to bother with. That is how documentation gets out of date.
3. About the location: This is somewhat in the same location. It is a Wiki off of the bigbang project. That is a very common thing to do.

Would it solve any problems if we moved the documentation to the GitLab Wiki?

NM, looks like that idea was already being discussed.

We took a poll in standup and the responses were "I don't care" or "I am in favor of wiki". No one was for putting the developer documentation in the bigbang repo code.

The poll from current BB Developers doesn't capture how a new developer would be able to discover. It is very common to have developer/contribution material co-located with open source projects and is often confusing when documentation is located outside the repo. Since we've struggled with having documentation in multiple places in the past, we're going to ensure that the BigBang documentation all resides within the one repo.

Documentation has already begun to diverge in the two weeks since this conversation started.

Will the Hugo work be impacted by having the MD files outside of the primary repository?

my issue with the wiki is that it can't be version controlled like the repo can.

What was the negative feedback against putting it with the repo?

added to epic &24 (closed)

changed iteration to Big Bang Iterations Feb 23, 2021 - Mar 8, 2021

added BB Documentation Standards label

Wiki saves history so we can recover if someone messes it up. And we don't need versioning. There is only one version of developer documentation and that is the current live version.