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: prevent documentation site API links from routing to 404 pages #1606

Merged
merged 1 commit into from Apr 8, 2019

Conversation

jkmdev
Copy link
Contributor

@jkmdev jkmdev commented Mar 30, 2019

Description

This fix adds a _config.yml file to the website/build folder so that github pages will load files with an underscore prefix. Also changes when 'API Reference' links are added to readme.md files to prevent them from linking to api documentation that wasn't built.

Motivation & context

Fix #1544
Github pages wouldn't recognize the documentation site api files because they had an underscore prefix, a .nojekyll or _config.yml file needed to be added to the sites root folder for them to be recognized. More info on can be found here.
'API Reference' links would be added to package readme.md documentation files even if the api documentation didn't build correctly. This would lead to a 404 error, since the link wasn't linking to anything in these cases.

Issue type checklist

  • Chore: A change that does not impact distributed packages.
  • Bug fix: A change that fixes an issue, link to the issue above.
  • New feature: A change that adds functionality.

Is this a breaking change?

  • This change causes current functionality to break.

Process & policy checklist

  • I have added tests for my changes.
  • I have tested my changes.
  • I have updated the project documentation to reflect my changes.
  • I have read the CONTRIBUTING documentation and followed the standards for this project.

@stale
Copy link

stale bot commented Apr 7, 2019

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the warning:stale No recent activity within a reasonable amount of time label Apr 7, 2019
@nicholasrice
Copy link
Contributor

@jkmdev Looks like this one is ready to go - if you can rebase it against master we can check it in.

@stale stale bot removed the warning:stale No recent activity within a reasonable amount of time label Apr 8, 2019
@jkmdev
Copy link
Contributor Author

jkmdev commented Apr 8, 2019

@nicholasrice Alright, it's updated, although the ci build failed. Not sure if it's something I'd need to fix or if it just randomly failed this one time

@nicholasrice
Copy link
Contributor

@jkmdev yea sorry about that - noticed right after I pinged you! Just merged the fix so you should be good to go on this.

Thanks!

@codeclimate
Copy link

codeclimate bot commented Apr 8, 2019

Code Climate has analyzed commit e223385 and detected 0 issues on this pull request.

The test coverage on the diff in this pull request is 100.0% (50% is the threshold).

This pull request will bring the total coverage in the repository to 88.1% (0.0% change).

View more on Code Climate.

@nicholasrice nicholasrice merged commit 5434d62 into microsoft:master Apr 8, 2019
@nicholasrice
Copy link
Contributor

Thanks @jkmdev!

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.

All documentation site API links route to 404 page
4 participants