Navigation Menu

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

Doc site #1393

Merged
merged 2 commits into from Jul 4, 2017
Merged

Doc site #1393

merged 2 commits into from Jul 4, 2017

Conversation

retrohacker
Copy link
Member

Pre-Submission Checklist

  • Opened an issue discussing these changes before opening the PR
  • Ran the linter and tests via make prepush
  • N/A Included comprehensive and convincing tests for changes

Issues

Supports #912

We are moving to a simple jekyll based website. The source will live at https://github.com/restify/restify.github.io (maintainers already have access to this).

Changes

  • Allows our template to live in the restify.github.io repo while our documentation lives in the node-restify repo. We add node-restify as a submodule and remove all recursive submodules so github pages can do a full build.
  • Add's jekyll front-matter to docs
  • Re-organizes docs to follow layout of sidebar on the doc site
  • Removes content that is an awkward fit

Snapshot:

screenshot from 2017-06-30 15-43-34

@stevehipwell
Copy link

@retrohacker - I'd like to update the TypeScript definitions for Restify and to do so it would help if I could have access to the new documentation.

@retrohacker
Copy link
Member Author

Only tests failing are for Node.js v8, going ahead and merging to release the new doc site. Will pull over the doc updates from the old WIP site here soon.

@retrohacker retrohacker merged commit 76ee548 into 5.x Jul 4, 2017
@retrohacker
Copy link
Member Author

The new website is available at https://restify.github.io/

Will work on migrating DNS over this week.

@stevehipwell
Copy link

@retrohacker - All I'm getting is a single marketing page, where are the actual docs?

@stevehipwell
Copy link

@retrohacker - If I request the desktop site it works, so I assume it's a responsive bug.

@retrohacker
Copy link
Member Author

@stevehipwell ah! Good catch. Just pushed a fix. Looks like it was collapsing into a drop-down menu, but the hamburger icon was black on a black background! Should be visible now 😄

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.

None yet

3 participants