Skip to content

Fix links in contributing.md and add code of conduct to siteNav#1170

Merged
nbriannl merged 1 commit intoMarkBind:masterfrom
nbriannl:fix-links
Apr 11, 2020
Merged

Fix links in contributing.md and add code of conduct to siteNav#1170
nbriannl merged 1 commit intoMarkBind:masterfrom
nbriannl:fix-links

Conversation

@nbriannl
Copy link
Contributor

@nbriannl nbriannl commented Mar 31, 2020

What is the purpose of this pull request? (put "X" next to an item, remove the rest)

• [X] Documentation update
• [X] Bug fix

What is the rationale for this request?

Preview in #1139 showed correctly, but links are broken in actual site.

What changes did you make? (Give an overview)

Comparing the output resolved href in the deployed site code,
https://github.com/MarkBind/devdocs/blob/a43131f3fed86576c821e1a92696ece77b1768f3/devGuide/contributing.html#L61

I can conclude
{{baseUrl}}/devGuide/contributing/code-of-conduct.html resolved correctly to
/devdocs/devGuide/contributing/code-of-conduct.html

The reason why the code-of-conduct page was broken was because I forgot to configure docs/dg-site.json, hence it wasn't generated in the deployed site.

I incorrectly used baseurl instead of baseUrl. (This error did not show up in netifly and was not caught by anyone). Changed it accordingly. I believe that the rest of the links should now resolve correctly as well.

Provide some example code that this change will affect:

Is there anything you'd like reviewers to focus on?

Testing instructions:

Compare broken links in https://markbind.org/devdocs/devGuide/contributing.html, and see if the corresponding links send to the correct pages

Proposed commit message: (wrap lines at 72 characters)

Fix contributing.md links, update siteNav

Fix baseurl to baseUrl and added Code of Conduct to siteNav

@nbriannl nbriannl added the pr.DocsUpdate 📃 Pure changes to the documentation, such as typo, restructuring, etc label Mar 31, 2020
@nbriannl
Copy link
Contributor Author

nbriannl commented Mar 31, 2020

Can't seem to link to code-of-conduct even though it shows up on netifly https://deploy-preview-1170--markbind-master.netlify.com/devguide/contributing/code-of-conduct ... 😞

https://markbind.org/devdocs/devGuide/devGuide.html#requirement
https://markbind.org/devdocs/devGuide/contributing/code-of-conduct.html (wouldn't this be correct?)

Given this structure?
image

Update: I forgot to update docs\dg-site.json

@nbriannl
Copy link
Contributor Author

nbriannl commented Mar 31, 2020

Edit: Resolved. Spelt baseUrl as baseurl

I don't really understand why docs\_markbind\layouts\devGuide\navigation.md

<navigation>

<span class="lead">**Developer Guide**</span>

* [Developer Guide]({{baseUrl}}/devGuide/devGuide.html)
* [Maintainer Guide]({{baseUrl}}/devGuide/maintainerGuide.html)
* [Contributing]({{baseUrl}}/devGuide/contributing.html)

</navigation>

Can resolve with baseUrl === '/devdocs'

But any links present in docs\devGuide\contributing.md

Resolves with baseUrl === ''

@nbriannl nbriannl changed the title Fix links in contributing.md [WIP] Fix links in contributing.md Mar 31, 2020
@nbriannl nbriannl changed the title [WIP] Fix links in contributing.md Fix links in contributing.md Apr 1, 2020
Copy link
Contributor

@le0tan le0tan left a comment

Choose a reason for hiding this comment

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

Looks like code of conduct is accessible only from direct URL access of clicing the link in "Contributing" page. Would is be better if code of conduct is shown on the left navigation? Otherwise LGTM.

@nbriannl
Copy link
Contributor Author

nbriannl commented Apr 1, 2020

Looks like code of conduct is accessible only from direct URL access of clicing the link in "Contributing" page. Would is be better if code of conduct is shown on the left navigation? Otherwise LGTM.

Think i'll leave this as a good first issue for any newcomer this summer.

Edit: After thinking about, i think it's better to just do a quick change since i'm already here

@nbriannl nbriannl changed the title Fix links in contributing.md Fix links in contributing.md and add code of conduct to siteNav Apr 1, 2020
@nbriannl nbriannl requested a review from le0tan April 1, 2020 12:44
Copy link
Contributor

@ang-zeyu ang-zeyu left a comment

Choose a reason for hiding this comment

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

LGTM 👍


commit message title needs to be under 50 characters though @nbriannl

@ang-zeyu ang-zeyu added this to the v2.13.2 milestone Apr 1, 2020
@nbriannl
Copy link
Contributor Author

nbriannl commented Apr 1, 2020

commit message title needs to be under 50 characters though @nbriannl

Oh. My bad.

@nbriannl nbriannl merged commit a3b7a07 into MarkBind:master Apr 11, 2020
@nbriannl nbriannl deleted the fix-links branch April 16, 2020 09:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pr.DocsUpdate 📃 Pure changes to the documentation, such as typo, restructuring, etc

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants