Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create a new Code of Conduct Page #4249

Closed
9 of 10 tasks
Tracked by #4251 ...
jdingeman opened this issue Mar 22, 2023 · 10 comments · Fixed by #4600
Closed
9 of 10 tasks
Tracked by #4251 ...

Create a new Code of Conduct Page #4249

jdingeman opened this issue Mar 22, 2023 · 10 comments · Fixed by #4600
Assignees
Labels
Complexity: Large Feature: API Coding requires using an API feature: code of conduct ready for design lead role: front end Tasks for front end developers size: 5pt Can be done in 19-30 hours

Comments

@jdingeman
Copy link
Member

jdingeman commented Mar 22, 2023

Overview

Since HfLA is no longer bound by Code for America's Code of Conduct, we need to update HfLA's Code of Conduct. For this issue, you will need to create a new Code of Conduct page so that developers will read the Code that pertains to HfLA specifically.

Action Items

  • In website/pages, create a new html file named code-of-conduct.html
    • Add the Jekyll front matter block for this new page
    • Use layout: default
    • Make the permalink to the page with permalink: code-of-conduct so Jekyll can build the page
    • Include the file in index.html
  • Using the GitHub REST API, use the hackforla/codeofconduct README.md file to populate the website's current CODEOFCONDUCT.md dynamically
    • The idea here is that the content of the Code of Conduct only gets edited in one place and can be applied across all projects
    • This will then be rendered onto the new code-of-conduct.html file using Liquid
    • Be sure to separate the content as appropriate into
      • Header
      • Content Body
      • Footer

For PM/Tech Lead/Merge Team

  • When this PR associated with this issue is merged, add a "ready for design lead" label on this issue Create a new Code of Conduct Page #4249, and place it into the New Issue Approval Column so that design can review the layout and redesign as necessary.

Resources/Instructions

@jdingeman jdingeman added role: front end Tasks for front end developers Complexity: Medium P-Feature: About Us https://www.hackforla.org/about/ ready for dev lead Issues that tech leads or merge team members need to follow up on size: 2pt Can be done in 7-12 hours Draft Issue is still in the process of being created ready for product labels Mar 22, 2023
@jdingeman
Copy link
Member Author

jdingeman commented Mar 22, 2023

@ExperimentsInHonesty - I am testing out ways to do this. I looked at your Diff analysis and I was confused. Do you want the CODEOFCONDUCT.md file that currently exists in the website repo to just be a hard copy of the CODEOFCONDUCT.md in hackforla/codeofconduct? Or do you want the page to dynamically render from hackforla/codeofconduct without holding a hard copy inside the repo?

I was also not sure what the Feature label should be.

@jdingeman jdingeman added feature: code of conduct and removed Draft Issue is still in the process of being created P-Feature: About Us https://www.hackforla.org/about/ labels Mar 23, 2023
@ExperimentsInHonesty ExperimentsInHonesty added this to the 01. Compliance milestone Mar 23, 2023
@ExperimentsInHonesty
Copy link
Member

@jdingeman Use the same feature labels as the ones I put on this issue

Yes, I want to dynamically render from hackforla/codeofconduct without holding a hard copy inside the repo if possible. That way we are always only updating it in one place and that place is appropriate for all teams to link to.

@jdingeman jdingeman added Complexity: Large ready for product size: 3pt Can be done in 13-18 hours and removed Complexity: Medium ready for dev lead Issues that tech leads or merge team members need to follow up on size: 2pt Can be done in 7-12 hours labels Mar 30, 2023
@jdingeman
Copy link
Member Author

@ExperimentsInHonesty - I think it's possible using the GitHub API, but I think this will be considered a large issue. Please see DRAFT NOTES for potential roadblocks/questions.

@ExperimentsInHonesty
Copy link
Member

@jdingeman I think that if we do this

The Code of Conduct should be placed onto a card, similar to the HackforLA Platform card or the HackforLA Sustainability card

Then it's going to look weird because there is no header image and text. For now, let's just have it be
header | content directly on page | footer.
We will call that MVP. Then later we can always send it to design to decide how it should be different.

@ExperimentsInHonesty ExperimentsInHonesty added role: dev leads Tasks for technical leads ready for dev lead Issues that tech leads or merge team members need to follow up on and removed ready for product role: dev leads Tasks for technical leads labels Apr 2, 2023
@jdingeman jdingeman removed the ready for dev lead Issues that tech leads or merge team members need to follow up on label Apr 4, 2023
@github-actions
Copy link

github-actions bot commented Apr 6, 2023

Hi @bootcamp-brian, thank you for taking up this issue! Hfla appreciates you :)

Do let fellow developers know about your:-
i. Availability: (When are you available to work on the issue/answer questions other programmers might have about your issue?)
ii. ETA: (When do you expect this issue to be completed?)

You're awesome!

P.S. - You may not take up another issue until this issue gets merged (or closed). Thanks again :)

@bootcamp-brian
Copy link
Member

Availability for this week: Weekdays before 5pm
ETA: By end of next week (4/16)

@jdingeman jdingeman added size: 5pt Can be done in 19-30 hours and removed size: 3pt Can be done in 13-18 hours labels Apr 14, 2023
@github-actions github-actions bot added the To Update ! No update has been provided label Apr 14, 2023
@bootcamp-brian
Copy link
Member

Provide Update

  1. Progress: Currently researching ways to get the code of conduct to render dynamically from the readme file in the hackforla/codeofconduct repo.
  2. Blockers: Haven't been able to figure out a way to access the necessary info from a live browser environment yet.
  3. Availability: Tues-Fri next week
  4. ETA: Hopefully by the end of next week.

@bootcamp-brian
Copy link
Member

@ExperimentsInHonesty - From my research into this issue, using the GitHub REST API to get the info from the README.md file in the hackforla/codeofconduct repo doesn't seem like a great solution because it would require a lot more work in terms of parsing the data and doing a lot of DOM manipulation.

I think I've come up with a good alternative, though. If we use a GitHub action created in the hackforla/codeofconduct repo that triggers whenever the README.md file gets updated and uses GitHub REST API to copy that file's contents and create or update a corresponding .md file in the _includes directory of the website repo, we can then easily include that file on the code of conduct page while maintaining the markdown formatting from the original file. This would technically have a hard copy in the website repo, but its maintenance would be automated. I believe I've worked out the code to do this for the most part, but only someone who has write access to the hackforla/codeofconduct repo would be able to implement it.

Does this suggestion accomplish what you wanted and sound like a good option to you, Bonnie? Let me know how you want me to move forward with this issue.

@bootcamp-brian
Copy link
Member

Provide Update

  1. Progress: Researched potential solutions for achieving the desired functionality but need input from leadership before proceeding any further.
  2. Blockers: No other blockers.
  3. Availability: Weekdays this week after 6pm.
  4. ETA: Hopefully within the next week if we can decide how to proceed at Sunday's meeting.

@github-actions github-actions bot removed the To Update ! No update has been provided label Apr 28, 2023
@bootcamp-brian
Copy link
Member

Provide Update

  1. Progress: Discussed solution and got approval to implement, however it turns out I still need extra permissions to implement. Will be inquiring about this at tomorrow's meeting.
  2. Blockers: Just what I mentioned in the progress report.
  3. Availability: Weekdays this week after 6pm.
  4. ETA: Within the next week.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Complexity: Large Feature: API Coding requires using an API feature: code of conduct ready for design lead role: front end Tasks for front end developers size: 5pt Can be done in 19-30 hours
Projects
Status: New Issue Approval
Development

Successfully merging a pull request may close this issue.

4 participants