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

New Docs #503

Draft
wants to merge 15 commits into
base: master
Choose a base branch
from
Draft

New Docs #503

wants to merge 15 commits into from

Conversation

ashmaroli
Copy link
Member

@ashmaroli ashmaroli commented Dec 4, 2022

What changed?

  • Stop recommending users to run importers via Ruby API. Instead revolve everything about using the jekyll import subcommands.
  • Separate layouts for documents in docs collection and for documents in importers collection.
  • Use front matter defaults to set up data for documents in importers collection.
  • Use a local plugin to inject JekyllImport::Importer subclass metadata into data of documents in importers collection. Extracted into separate PR: Document command-line-interface of importers #507
  • Render importer documents into /importers/NAME/ instead of current /docs/NAME/. (No redirection from old permalinks).
  • Replace default layout with base layout.

@netlify
Copy link

netlify bot commented Dec 4, 2022

Deploy Preview for jekyll-import ready!

Name Link
🔨 Latest commit 57e2e8c
🔍 Latest deploy log https://app.netlify.com/sites/jekyll-import/deploys/638cec658fe45f0009402065
😎 Deploy Preview https://deploy-preview-503--jekyll-import.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@ashmaroli
Copy link
Member Author

@parkr Hello. Even though this is still a WIP, I believe it's developed enough for a preview and first-round of feedback on the Frontend / UX.
I have set up Netlify to render deploy previews for pull requests. You'll find the links to the preview in a comment at the top of this page 👆
Thanks.

@parkr
Copy link
Member

parkr commented Dec 15, 2022

Hey @ashmaroli, this is in my queue to review but my high level thoughts are:

  1. Lack of consistency with Jekyllrb.com is not desirable IMO. I prefer them to be of the same general structure so that it's easy to navigate between the two and both feel familiar.
  2. I really like the new pages for each specific importer, especially using the CLI directly.
  3. I think the massive note about dependencies on each importer docs page should be elided into the usage with just a "gem install ..." right above the incantation. Right now it takes up a lot of the page.
  4. I really missed having all the importers listed on the home page. Makes it easy for someone to know at a glance if their platform of choice is supported.

@ashmaroli
Copy link
Member Author

this is in my queue to review..

No hurry, @parkr. This is still a WIP.
I just wanted your inputs on current look-n-feel.

Your high-level thoughts above is clear that you don't desire a redesign, but just want the CLI usage section to swap existing recommendation based on using Ruby API directly.

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.

2 participants