search

cagov / data-infrastructure

CalData infrastructure
https://cagov.github.io/data-infrastructure
MIT License
7 stars 0 forks source link

Git norms doc #401

Closed tnrahim closed 4 days ago

tnrahim commented 1 month ago

Adds https://docs.google.com/document/d/1mv-0hymSr2WIUgE-9l6P53M44Fd13nQ_QUpgxSIgKTU/edit and https://docs.google.com/document/d/1WK673QArNxdJi-JSf2J30GhmNk45gyYF2WCPLfzE8a8/edit#heading=h.9s45exk8c5x4

into project docs

tnrahim commented 1 month ago

closes #270

jkarpen commented 1 month ago

@tnrahim I'm noticing in the "GitHub and Continuous Integration" page markdown preview there are a lot of headers showing up with ## in front of them. Not sure if that's rendering as you intended. image

(Also just noticed a typo in "repository" in the screenshot above)

Also at the top of that page it says "bookmark your project's GitHub repo" and links to a generic public repo. I'm wondering if that could confuse people... Is the intention to replace that link with the actual project repo for each client where this gets published?

Aside from that I saw no issues with the "GitHub and Project Management" page.

tnrahim commented 1 month ago

Generic Repo I used the generic repo to make the documentation more project agnostic. Teams can update that link to point to their particular project if they are personalizing these docs.

I've updated the other items as well.

jkarpen commented 1 month ago

The project management doc looks good to me. I'm thinking that a lot of the intro to git/github content could go in the "learning" tab, and at that point the project management doc might work better in the "Code Development" subsection. Thoughts @jkarpen?

I agree with that (moving the project management doc to Code Development). It does seem similar to some of the items in that section.

tnrahim commented 1 week ago

The project management doc looks good to me. I'm thinking that a lot of the intro to git/github content could go in the "learning" tab, and at that point the project management doc might work better in the "Code Development" subsection. Thoughts @jkarpen?

I agree with that (moving the project management doc to Code Development). It does seem similar to some of the items in that section.

Project Management doc has been moved to the code development section.