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

[#2011] Fix bugs in UG #2013

Merged
merged 7 commits into from
Jul 14, 2023
Merged

[#2011] Fix bugs in UG #2013

merged 7 commits into from
Jul 14, 2023

Conversation

nseah21
Copy link
Contributor

@nseah21 nseah21 commented Jun 29, 2023 •
edited
Loading

Fixes #2011

Fix bugs in UG

Some of the links in the FAQ and troubleshooting
sections of the UG are not working. Some embedded 
content is also not being rendered correctly.

Let's update the links and fix the embedded content.

Other information

NA

@nseah21 nseah21 changed the title Fix faulty links to config files in FAQ [#2011] Fix faulty links to config files in FAQ Jun 30, 2023
ckcherry23
ckcherry23 requested changes Jul 1, 2023
View reviewed changes
Copy link
Member

@ckcherry23 ckcherry23 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 fixing the broken links @nseah21!

I just have a minor comment about the commit message. Each line in it should be under 72 characters.
(You can read more about what we follow in the SE-EDU guidelines for submitting a PR.)

@nseah21
Copy link
Contributor Author

nseah21 commented Jul 2, 2023

Thank you for the reminder @ckcherry23. I have updated the commit message accordingly.

@ckcherry23 ckcherry23 requested review from a team July 2, 2023 05:43
@gok99
Copy link
Contributor

gok99 commented Jul 5, 2023

Thanks for catching these @nseah21

It looks like some links in the Troubleshooting appendix are also broken - could you do a quick look around the other sections and get them fixed here too?

@nseah21
Copy link
Contributor Author

nseah21 commented Jul 5, 2023 •
edited
Loading

Thank you for pointing them out, @gok99.

I have fixed the broken links, as well as some other UG bugs in troubleshooting.md and withTravis.md.

@gok99
Copy link
Contributor

gok99 commented Jul 6, 2023

Thanks! Could you also update the PR title and commit message?

@nseah21 nseah21 changed the title [#2011] Fix faulty links to config files in FAQ [#2011] Fix bugs in UG Jul 6, 2023
gok99
gok99 approved these changes Jul 6, 2023
View reviewed changes
Copy link
Contributor

@gok99 gok99 left a comment

Choose a reason for hiding this comment

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

LGTM!

@chan-j-d chan-j-d merged commit ae805c8 into reposense:master Jul 14, 2023
9 of 10 checks passed
@github-actions
Copy link
Contributor

The following links are for previewing this pull request:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gok99 gok99 gok99 approved these changes

@ckcherry23 ckcherry23 ckcherry23 approved these changes

Assignees
No one assigned
Labels
s.ToMerge
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Documentation links to config files don't work
4 participants
@nseah21 @gok99 @ckcherry23 @chan-j-d