Link to DevGuide in markbind.org

[le0tan]

Is your request related to a problem?

Currently we have no easy access to the developer's guide from markbind.org. It would be better if developer's guide along with contribution guide can be easily accessible from the official website.

[nbriannl]

Curious, why are we able to see those links in netifly previews but not in the actual site?

[Tejas2805]

I thought this was intentional as it was meant for the users.

[nbriannl]

Anyways, I feel that we should make the dev guide visible to users visiting the official website. I am interested to know we have it the way now. @marvinchin Open source projects like https://www.gatsbyjs.org/ have their contributing section visible.

[Tejas2805]

Figured it. This is because we are using site.json for Netlify previews. Whereas for the markbind.org we use ug-site.json. This is why the difference.

This is what I think. Let me know your thoughts on it.

[Tejas2805]

site.json for markbind.org

"glob": ["**/*.mbd", "*.md", "userGuide/*.md"]

site.json for our previews

"glob": ["**/*.mbd", "*.md", "userGuide/*.md", "devGuide/*.md", "devGuide/*/*.md"]

[le0tan]

I think @Tejas2805 has found the problem, it's in this file https://github.com/MarkBind/markbind/blob/master/docs/ug-site.json

I support @nbriannl on the idea of making the dev guide publicly visible for similar reasons.

[damithc]

It is fine to give the DG link in public.
Keep in mind the UG should follow the latest released version while DG should follow the master branch.

[Tejas2805]

Can someone guide me on where to find _markbind for the latest release (markbind.org site)? Can't seem to find it. Will accordingly make the PR then.

[Tejas2805]

Can someone guide me on where to find _markbind for the latest release (markbind.org site)? Can't seem to find it. Will accordingly make the PR then.

Think just adding the pages should be enough. Since all headers use it.

[damithc]

Can someone guide me on where to find _markbind for the latest release (markbind.org site)? Can't seem to find it. Will accordingly make the PR then.

This one?
https://github.com/MarkBind/markbind/tree/master/docs

[nbriannl]

Hi, sorry for checking in late.

The UG is hosted in https://github.com/MarkBind/markbind.github.io
And DG is hosted in https://github.com/MarkBind/devdocs

The UG is rebuilt every site release, and the DG is rebuilt every commit.

To solve this issue, you could update the Navbar and SiteNav of the UG to contain links and point to the DG

And vice versa, update the Navbar and SiteNav of the DG to include links and point to the UG

Edit: Looking at the structure abit more.

[damithc]

Hi, sorry for checking in late.

The UG is hosted in https://github.com/MarkBind/markbind.github.io
And DG is hosted in https://github.com/MarkBind/devdocs

The UG is rebuilt every site release, and the DG is rebuilt every commit.

To solve this issue, you could update the Navbar and SiteNav of the UG to contain links and point to the DG

And vice versa, update the Navbar and SiteNav of the DG to include links and point to the UG

Edit: Looking at the structure abit more.

Sounds good, if that is indeed the case.

[nbriannl]

Ah, I noticed what stopped the respective links to show was filter tags.

[damithc]

Ah, I noticed what stopped the respective links to show was filter tags.

Sounds right. After all, we should be using our own cool features :-)

[Tejas2805]

Ah, I noticed what stopped the respective links to show was filter tags.

Ya, I noticed this too right now.

[nbriannl]

Ok. I did some investigation.

To bring everyone back on track,

Netifly preview:

• Uses site.json, filter tag set to ["environment--ug", "environment--dg"]

UG:

• Site is hosted at https://github.com/MarkBind/markbind.github.io
• Is updated whenever there is a new release
• Uses ug-site.json, filter tag set to ["environment--ug"]

DG:

• Site is hosted at https://github.com/MarkBind/devdocs
• Is updated whenever a new commit appears on MarkBind's main repository's master branch.
• Uses dg-site.json, filter tag set to ["environment--dg"]

The filter tags is the reason why in the NavBar you don't see Dev Guide when in the UG and you don't see User Guide when in the DG.

---

So it seems the changes includes

• Tweaking the filter tags accordingly.
• Making sure the docs are using the correct header.md, which is determined by the layout: in the <frontmatter>

e.g.

<frontmatter>
  title: "Developer Guide"
  layout: devGuide
  pageNav: default
</frontmatter>

or

<frontmatter>
  title: "User Guide - {{ title }}"
  layout: userGuide
</frontmatter>

• Making sure the link in the header.md is point to the correct url.

i.e.

    <div tags="environment--ug"><li><a href="{{baseUrl}}/userGuide/index.html" class="nav-link">USER GUIDE</a></li></div>
    <div tags="environment--dg"><li><a href="{{baseUrl}}/devGuide/index.html" class="nav-link">DEVELOPER GUIDE</a></li></div>

• This point has to be handled properly because the baseUrls of the UG and DG, and netifly previews are different.

It would help if someone checked on my suggestion as well.