city-of-helsinki / bestpractice Goto Github PK

Is your feature request related to a problem? Please describe.
I cannot find the github issue/pr templates from the documentation

Describe the solution you'd like
Please add a mention that these templates are available along with links to the templates in the main bulk of the documentation

Describe alternatives you've considered

Additional context

Sometimes a project might have a feature that is ready for testing, but not for use in production. To avoid problems with long living branches, it is customary to create feature flags where the feature can be turned on for certain users, certain environments or otherwise.

Would be great to add something to dev.hel.fi about when and how to use feature flags. Martin Fowler has written an interesting article:
https://martinfowler.com/articles/feature-toggles.html

@Rikuoja

This bounds min/max seems odd:

https://github.com/City-of-Helsinki/bestpractice/blame/master/docs/resources/maps.md#L103

Idea is to pick X and Y of northwest corner?

When I was working in ratkis we were using a checklist for things to go through before going live with a new project. Things like accessibility review, security audit, DNS configuration, analytics etc were all covered. Would be great if it was part of this best practice page so that outsiders also can reference it and use it as inspiration for our own projects!

Describe the bug
Due to project documentation having been moved to Confluence wiki, it is now unclear where issues and pull requests related to Helsinki API documentation should be opened. For example Dokumentaatiokäytännöt website links to this bestpractice repository. Koodikontribuutioiden hyväksyminen links to nowhere.

Additional points:

• Some documentation that used to live in dev.hel.fi website no longer exists.
• Confluence wiki seems to be less accessible to outsiders as some documentation is hidden from the public.

Desktop (please complete the following information):

• OS: macOS 13.0.1
• Browser Safari
• Version 16.1