Skip to content

Conversation

@tnrahim
Copy link
Contributor

@tnrahim tnrahim commented Oct 11, 2024

@tnrahim tnrahim marked this pull request as draft October 11, 2024 16:01
@tnrahim
Copy link
Contributor Author

tnrahim commented Oct 11, 2024

closes #270

@tnrahim tnrahim linked an issue Oct 21, 2024 that may be closed by this pull request
2 tasks
@tnrahim tnrahim marked this pull request as ready for review October 21, 2024 21:12
@jkarpen
Copy link
Collaborator

jkarpen commented Oct 24, 2024

@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
Copy link
Contributor Author

tnrahim commented Oct 25, 2024

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.

Copy link
Member

@ian-r-rose ian-r-rose left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

@jkarpen
Copy link
Collaborator

jkarpen commented Oct 25, 2024

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
Copy link
Contributor Author

tnrahim commented Nov 14, 2024

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.

@tnrahim tnrahim merged commit 2bdfdbb into main Nov 21, 2024
5 checks passed
@tnrahim tnrahim deleted the git_norms_doc branch November 21, 2024 21:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Make GitHub norms document accessible to stakeholders

5 participants