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

Elaborate and merge F7, F8, F9 criterias #26

Closed
janhalen opened this issue Apr 17, 2024 · 4 comments · Fixed by #41
Closed

Elaborate and merge F7, F8, F9 criterias #26

janhalen opened this issue Apr 17, 2024 · 4 comments · Fixed by #41
Assignees
Labels
governance template change request Issues that are related to change proposed to the goverance template

Comments

@janhalen
Copy link
Member

janhalen commented Apr 17, 2024

What part needs to change?

F7 	Driftskrav til løsningen er dokumenteret 	
F8 	Løsningen er dokumenteret på teknisk niveau 	
F9 	Teknisk implementering af løsningen er dokumenteret

Obstacle

These criteria can be confusing and some parts even overlapping..

Background

Propose solution

This criteria should follow the "Document the code" criteria from Foundation for Puclic Code.

References

https://standard.publiccode.net/criteria/document-the-code.html

https://dzone.com/articles/the-anatomy-of-a-great-open-source-documentation-h

@janhalen janhalen added the governance template change request Issues that are related to change proposed to the goverance template label Apr 17, 2024
@janhalen janhalen self-assigned this Apr 17, 2024
@janhalen janhalen changed the title [Remove/Keep/Elaborate] part [X#] of the governance template Elaborate and merge F7, F8, F9 criterias Apr 17, 2024
@janhalen
Copy link
Member Author

janhalen commented Apr 23, 2024

Add to the criteria that the way the documentation should be written somewhat along these lines:
"Os2 anviser dokumentations skabelonen placeret.. -> link"
"OS2 follow the documentation requirements from Foundation for Public code"

@zorp, any comments?

@janhalen
Copy link
Member Author

janhalen commented Apr 23, 2024

This criteria and specifically the "how-to" document should be linked to the https://github.com/OS2offdig/os2-docs-template.

Moved to #36

@janhalen
Copy link
Member Author

janhalen commented May 7, 2024

  • The reference to the Foundation for public code should be moved to our documentation-template repo.

@zorp - SFPC criteria now mentioned in the template README --> https://github.com/OS2offdig/os2-docs-template/blob/main/README.md

@janhalen
Copy link
Member Author

janhalen commented May 15, 2024

Proposal:

Merge F7, F8 and F9 into a new F7 criteria: "Alt dokumentation til projektet udarbejdes med og overholder OS2s standardskabelon for dokumentation."

@janhalen janhalen linked a pull request May 31, 2024 that will close this issue
@zorp zorp closed this as completed in #41 Jun 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
governance template change request Issues that are related to change proposed to the goverance template
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant