search

enonic / doc-xp

Enonic XP > 7.0 Reference Documentation
2 stars 3 forks source link

Create issues for all TODOs spread over the docs #91

Closed alansemenov closed 4 years ago

alansemenov commented 4 years ago

We need to create a separate issue for every page with "TODO", and remove TODOs from the page and eventually from the entire portal. Every issue should have a link to the page and describe which parts of the page require work (if the page is not totally empty).

Example 1 (an empty page with nothing but "TODO" on it): https://developer.enonic.com/docs/xp/stable/runtime/media/image-service

Create an issue titled "TODO: Image Service" with link to the page in the issue body

Example 2 (page with content, with some TODOs in various places): https://developer.enonic.com/docs/xp/stable/deployment/config

Create an issues titled "TODO: Deployment / configuration". In the issue body have a link to the page, and then describe the list of TODOs:

_* "Variables" section: how to inject variables

hjelmevold commented 4 years ago

I've started creating issues in the doc-xp repo now.

alansemenov commented 4 years ago

It's an issue to not forget to create issues 😂

hjelmevold commented 4 years ago

I've now finished creating new issues for replacing TODOs with documentation, as well as updated the title of existing issues that dealt with the same type of TODOs. I've prefixed them all with "Cleanup TODOs: " https://github.com/enonic/doc-xp/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+cleanup

alansemenov commented 4 years ago

@hjelmevold Remember to remove the actual "TODOs" from the docs: https://developer.enonic.com/search?q=todo (also good idea that we actually covered all of them with the issues)

hjelmevold commented 4 years ago

I've now commented out all TODOs so they are no longer visible on the site (see commit https://github.com/enonic/doc-xp/commit/888057786ef074d503c7eb16b5e045b6c360ef96)