Add a documentation guideline about autoware-documentation HOT 7 CLOSED

In that case, I feel it's covered by If you are curious about what to write or whether your contribution is worthwhile or not, you can ask on Q&A page., right?

That's why I opened this pull request first.

from autoware-documentation.

@IshitaTakeshi Thank you for opening an issue. I have some comments.

If you have knowledge about Autoware usage or functionality, or if you have a question about Autoware, and once it is resolved, turn the knowledge into the documentation!

I think this part should be in https://autowarefoundation.github.io/autoware-documentation/main/help/support-guidelines/ or https://autowarefoundation.github.io/autoware-documentation/main/contributing/.

https://autowarefoundation.github.io/autoware-documentation/main/contributing/documentation-guidelines/ is for how to write good documents.

If you can make a documentation page based on your knowledge, please send a pull request. If you are unaware of if you can open a pull request or unaware of the format, you can ask on the feature requests page.

The feature request category isn't for documentation.

from autoware-documentation.

Also, could you list up what is unclear with the current documentation?
For example,

• Users can't understand how to submit a PR about ....

from autoware-documentation.

If you have knowledge about Autoware usage or functionality, or if you have a question about Autoware, and once it is resolved, turn the knowledge into the documentation!

In which part of the contribution page should I place it?

from autoware-documentation.

Also, could you list up what is unclear with the current documentation?

I was unsure about how to make a new page in the documentation. I wanted to add a page that explains how to initialize the NDT pose. But it was unclear how to add a documentation page, so I want to update the contribution guideline.

from autoware-documentation.

If you have knowledge about Autoware usage or functionality, or if you have a question about Autoware, and once it is resolved, turn the knowledge into the documentation!

In which part of the contribution page should I place it?

I personally feel:

• Regarding If you have knowledge about Autoware usage or functionality, https://autowarefoundation.github.io/autoware-documentation/main/contributing/#contribution-workflows

• Regarding if you have a question about Autoware, and once it is resolved, turn the knowledge into the documentation!, https://autowarefoundation.github.io/autoware-documentation/main/help/support-guidelines/#github-discussions

I was unsure about how to make a new page in the documentation. I wanted to add a page that explains how to initialize the NDT pose. But it was unclear how to add a documentation page, so I want to update the contribution guideline.

In that case, I feel it's covered by If you are curious about what to write or whether your contribution is worthwhile or not, you can ask on [Q&A page](https://github.com/autowarefoundation/autoware/discussions/categories/q-a)., right?

I feel it should be placed in https://autowarefoundation.github.io/autoware-documentation/main/contributing/#contribution-workflows.

from autoware-documentation.

I close this issue as the documentation has been largely updated in #91

from autoware-documentation.