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.

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

feat: add a help page #28

Merged
merged 6 commits into from
Sep 10, 2024
Merged

feat: add a help page #28

merged 6 commits into from
Sep 10, 2024

Conversation

Meng-20
Copy link
Collaborator

@Meng-20 Meng-20 commented Sep 9, 2024

Added a help page to cfm-webui. The user can get the resources on how to use our product, trouble shottings and ask for help.
Here is the snapshot.
image

@Meng-20 Meng-20 self-assigned this Sep 9, 2024
@scott-howe-1
Copy link
Collaborator

Can you put a snapshot of the help page in the PR description please, thanks.

@scott-howe-1
Copy link
Collaborator

2 things:

  • As part of this PR, please add a placeholder "Troubleshooting" wiki page to the cfm wiki. Just add "under construction" or something on that page for now. Then, add that link to this PR (so the webui troubleshooting link goes to the new placeholder wiki page)
  • Create a separate ticket for adding additional information to the wiki troubleshooting page. Be sure to attach a link to the Errata document that Hongjian mentioned (for idea of things to add to the troubleshooting page).

Thanks.

@Meng-20
Copy link
Collaborator Author

Meng-20 commented Sep 10, 2024

2 things:

  • As part of this PR, please add a placeholder "Troubleshooting" wiki page to the cfm wiki. Just add "under construction" or something on that page for now. Then, add that link to this PR (so the webui troubleshooting link goes to the new placeholder wiki page)
  • Create a separate ticket for adding additional information to the wiki troubleshooting page. Be sure to attach a link to the Errata document that Hongjian mentioned (for idea of things to add to the troubleshooting page).

Thanks.

Thank you, Scott, I have updated my code, added a placeholder for the troubleshooting wiki page and created a new ticket to implement it. please check.

Copy link
Collaborator

@scott-howe-1 scott-howe-1 left a comment

Choose a reason for hiding this comment

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

Looks good.

Don't forget to modify your PR commit message format, when you merge, to include "feat:".

@Meng-20 Meng-20 merged commit a8e0758 into main Sep 10, 2024
5 checks passed
@Meng-20 Meng-20 deleted the feature/help_page branch September 10, 2024 21:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants