Sort the files in developer/explanation into respective categories#403
Sort the files in developer/explanation into respective categories#403odadacharles wants to merge 5 commits intocanonical:mainfrom
Conversation
Signed-off-by: Charles Odada <charles.odada@canonical.com>
Signed-off-by: Charles Odada <charles.odada@canonical.com>
Signed-off-by: Charles Odada <charles.odada@canonical.com>
Signed-off-by: Charles Odada <charles.odada@canonical.com>
Signed-off-by: Charles Odada <charles.odada@canonical.com>
odadacharles
force-pushed
the
dev-sec-sort
branch
from
b450137 to
631d099
Compare
docs/developer/explanation/best-practices-for-development/best-practices-for-development.rst
Show resolved
Hide resolved
docs/developer/explanation/best-practices-for-development/bug-triage-process-background.rst
Show resolved
Hide resolved
There was a problem hiding this comment.
This looks like it might be better suited to the "best practices for development" category too.
There was a problem hiding this comment.
I'm not sure which doc you're referring to here. This is the database index page.
docs/developer/explanation/deploying-launchpad-changes/deploying-launchpad-changes.rst
Show resolved
Hide resolved
There was a problem hiding this comment.
I am not sure about the difference between the 'development best practices' category above vs "developing Launchpad" that this one is under. It feels like they are more or less the same. So this categorization could be very confusing and hence unnecessary too.
There was a problem hiding this comment.
Again, I question the relevance of this under "setting up Launchpad". This feels like it has the explanation of a common task that a developer might need to do.
There was a problem hiding this comment.
Similar comment as before. It makes no sense to have a landing page with the same name as the containing folder. If you really want to have this page, maybe consider using index.rst which will render to index.html?
3 participants
Sort files into folders for easier location/management/maintenance of individual docs. There will be no visible difference in the rendered docs or navigation, but this will make it easier to locate individual files during maintenance.
Preview: https://canonical-ubuntu-documentation-library--403.com.readthedocs.build/launchpad/developer/explanation/