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

Fix link to extending.md #471

Closed
wants to merge 1 commit into from
Closed

Fix link to extending.md #471

wants to merge 1 commit into from

Conversation

ryanclarke
Copy link

@ryanclarke ryanclarke commented Jul 2, 2017

The ".md" filetype was missing from the link path.

Copy link

@danielpost danielpost left a comment

Choose a reason for hiding this comment

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

Thanks!

EDIT: Actually, just wondering. Should it be the full link (https://github.com/netlify/netlify-cms/blob/master/docs/extending.md), the way we currently have it in intro.md? Not sure if it makes a difference.

@erquhart
Copy link
Contributor

erquhart commented Jul 3, 2017

A root relative path is better, actually, same way I did it in my latest PR. Not sure if we have a consistent approach across the docs.

Copy link
Contributor

@erquhart erquhart left a comment

Choose a reason for hiding this comment

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

@ryanclarke thanks for this! I'm now wondering if there are other links where this is happening.

The problem here is that the repo docs are used to generate the docs site. The repo needs .md, but the docs site needs the extension left off. We'll need to determine the right approach. We're using Markdown Magic in the docs repo, maybe it's just a configuration thing.

Another option is to simply remove the extension from the files themselves, but we'll consider that a last resort.

@erquhart
Copy link
Contributor

erquhart commented Jul 3, 2017

So here's what I'm seeing:

  • The docs site is our primary documentation, so we should leave links without extension so they continue working there
  • To fix links within the docs, we'll probably need to write a Markdown Magic plugin on the docs site repo to transform .md extension links.
  • Once the plugin is in place, this PR will be eligible for merge. Any similar links should be updated at that point as well.

We may also consider other means for transforming source repo docs to html, but a quick search did not reveal anything promising.

@verythorough
Copy link
Contributor

We can likely look to the docs implementation used by Serverless, primarily coded by @DavidWells, who also created Markdown Magic.

They keep docs in the repo, as in this page (note the link at the bottom points to an .md file)
https://github.com/serverless/serverless/blob/master/docs/providers/aws/guide/installation.md

Then use those files to generate the main site, as in this page (with no extension on the last link)
https://serverless.com/framework/docs/providers/aws/guide/installation/

I don't think they use Markdown Magic as a separate entity, but have it integrated into the code (before MM was broken out). Code for content importing and conversion can be found in here:
https://github.com/serverless/site/tree/master/scripts/docs

@erquhart
Copy link
Contributor

erquhart commented Jul 3, 2017

@erquhart
Copy link
Contributor

erquhart commented Sep 2, 2017

This will be properly fixed under #511. Closing.

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.

4 participants