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.

Sign up for GitHub

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

Jump to bottom

docs: add support guidelines #40

Merged
merged 14 commits into from
Mar 11, 2022
Merged

docs: add support guidelines #40

merged 14 commits into from
Mar 11, 2022

Conversation

kenji-miyake
Copy link
Contributor

@kenji-miyake kenji-miyake commented Mar 3, 2022 •
edited
Loading

Related: #6, #7

@kenji-miyake kenji-miyake added the type:documentation Creating or refining documentation. label Mar 3, 2022
@github-actions
Copy link

github-actions bot commented Mar 3, 2022 •
edited
Loading

Documentation URL: https://autowarefoundation.github.io/autoware-documentation/pr-40/
Modified URLs:

@kenji-miyake kenji-miyake mentioned this pull request Mar 3, 2022
Closed
@kenji-miyake
Copy link
Contributor Author

kenji-miyake commented Mar 3, 2022 •
edited
Loading

ERROR: 1 dead links found!
[✖] https://github.com/autowarefoundation/autoware/discussions/new?category=q-a → Status: 404

? 🤔
https://github.com/autowarefoundation/autoware-documentation/runs/5407750168?check_suite_focus=true#step:3:398

-> 8578ee1

isamu-takagi
isamu-takagi reviewed Mar 8, 2022
View reviewed changes
docs/help/support-guidelines.md Outdated Show resolved Hide resolved
docs/help/support-guidelines.md Show resolved Hide resolved
BonoloAWF
BonoloAWF suggested changes Mar 8, 2022
View reviewed changes
docs/help/support-guidelines.md Outdated Show resolved Hide resolved
docs/help/support-guidelines.md Show resolved Hide resolved
@kenji-miyake kenji-miyake mentioned this pull request Mar 9, 2022
Merged
Joshua Whitley and others added 4 commits March 9, 2022 18:29
@kenji-miyake
Adding first pass at support guidelines.
e4d71b2 
Rename and move documentation pages for clarity

[!808] Move index files for design docs and expand into README files

[!821] Fix numerours code highlighting and markup issues, add TOCs

- TOC still missing on design docs

[!835] Add AVP instructions to docs

Other improvements of the docs include

- table-of-contents generation fixed
- replace links to external markdown files with HTML. Not sure why doxygen doesn't complain in CI, it failed with version 1.8.13 in my ADE
- spell checking of numerous documents
- remove subtree doc
@KeisukeShima @kenji-miyake
update documents
ed0d5d0 
Signed-off-by: Kenji Miyake <[email protected]>
@kenji-miyake
update documents
b503777 
Signed-off-by: Kenji Miyake <[email protected]>
@kenji-miyake
change link
ae7fe87 
Signed-off-by: Kenji Miyake <[email protected]>
xmfcx
xmfcx reviewed Mar 9, 2022
View reviewed changes
Copy link
Contributor

@xmfcx xmfcx left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This must have been a lot of work to write, thanks for your efforts.

docs/help/support-guidelines.md Outdated Show resolved Hide resolved
docs/help/support-guidelines.md Outdated Show resolved Hide resolved
docs/help/support-guidelines.md Outdated Show resolved Hide resolved
docs/help/support-guidelines.md Outdated Show resolved Hide resolved
docs/help/support-guidelines.md Outdated Show resolved Hide resolved
docs/help/support-guidelines.md Outdated Show resolved Hide resolved
docs/help/support-guidelines.md Outdated Show resolved Hide resolved
docs/help/support-guidelines.md Outdated Show resolved Hide resolved
docs/help/support-guidelines.md Show resolved Hide resolved
docs/help/support-guidelines.md Outdated Show resolved Hide resolved
@kenji-miyake kenji-miyake mentioned this pull request Mar 9, 2022
Closed
kenji-miyake and others added 6 commits March 9, 2022 23:43
xmfcx
xmfcx approved these changes Mar 11, 2022
View reviewed changes
Copy link
Contributor

@xmfcx xmfcx left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the great work!

@kenji-miyake kenji-miyake merged commit 41eeea7 into main Mar 11, 2022
@kenji-miyake kenji-miyake deleted the add-support-guidelines branch March 11, 2022 10:43
@tier4-autoware-public-bot tier4-autoware-public-bot bot mentioned this pull request Mar 12, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@isamu-takagi isamu-takagi isamu-takagi left review comments

@BonoloAWF BonoloAWF BonoloAWF requested changes

@xmfcx xmfcx xmfcx approved these changes

@mitsudome-r mitsudome-r Awaiting requested review from mitsudome-r

Assignees
No one assigned
Labels
type:documentation Creating or refining documentation.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@kenji-miyake @xmfcx @isamu-takagi @BonoloAWF @KeisukeShima