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

Review technical documentation files #274

Closed
1 task done
edhamiltonHO opened this issue Sep 26, 2023 · 3 comments · Fixed by #328
Closed
1 task done

Review technical documentation files #274

edhamiltonHO opened this issue Sep 26, 2023 · 3 comments · Fixed by #328
Assignees
Labels
ACP-migration Relating to moving the repo to ukhomeoffice and ACP

Comments

@edhamiltonHO
Copy link
Contributor

edhamiltonHO commented Sep 26, 2023

Which content do you think should be reviewed?
Documentation files in repo root, e.g. README.md, CONTRIBUTING.md, and the technical decision log

Why do you think we should review this?
As part of the migration to UKHomeOffice and new hosting, a number of our files will need to be amended. Also the technical decision log will need to reflect the chance

Please confirm the below

  • I have checked through the issues on the repository and don't think this has already been suggested
@edhamiltonHO edhamiltonHO added the ACP-migration Relating to moving the repo to ukhomeoffice and ACP label Sep 26, 2023
@edhamiltonHO
Copy link
Contributor Author

edhamiltonHO commented Oct 18, 2023

Needs to cover at minimum

  • Update CONTRIBUTING.md for

    • Make changes - do we want this to recommend forking the repo?
    • Pull requests - to reference CODEOWNERS in 'who can merge your PR'
    • Build, release, deploy - Update deployment detail (currently states GitHub pages)
    • Branching strategy - remove reference to GitHub pages
  • Update README.md - remove reference to GitHub pages

  • Update SECURITY.md - change guidance for reporting a vulnerability to 'raise an issue' or email [email protected]

  • Technical decision log - to include decision to migrate repo, and move hosting to HO platform

@keithkennedyHO
Copy link
Contributor

Make changes - do we want this to recommend forking the repo?

I am not aware of us requiring this as other repositories do so unsure here. This is not how PRs generated by guilds or development teams are working (which is fine, of course). However, for external contributors, this is a good approach to take, I think and worth suggesting.

@keithkennedyHO keithkennedyHO linked a pull request Oct 30, 2023 that will close this issue
1 task
@keithkennedyHO keithkennedyHO removed a link to a pull request Oct 30, 2023
1 task
@keithkennedyHO keithkennedyHO linked a pull request Oct 30, 2023 that will close this issue
1 task
@edhamiltonHO
Copy link
Contributor Author

OK, I think leave this as is, it is not broken

Looking through though I noticed that section on raising a security vulnerability issue was out of sequence and interfering with the flow for making a change. I've added little commit to fix

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ACP-migration Relating to moving the repo to ukhomeoffice and ACP
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants