jekyll-import icon indicating copy to clipboard operation
jekyll-import copied to clipboard
verified publisher icon jekyll

New Docs

Open ashmaroli opened this issue 3 years ago • 4 comments

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: #507
  • Render importer documents into /importers/NAME/ instead of current /docs/NAME/. (No redirection from old permalinks).
  • Replace default layout with base layout.

ashmaroli avatar Dec 04 '22 18:12 ashmaroli

Deploy Preview for jekyll-import ready!

Name Link
Latest commit 57e2e8c308ed482e53ef34ad2102d04a59720df4
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.

netlify[bot] avatar Dec 04 '22 18:12 netlify[bot]

@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.

ashmaroli avatar Dec 11 '22 16:12 ashmaroli

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.

parkr avatar Dec 15 '22 21:12 parkr

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.

ashmaroli avatar Dec 16 '22 12:12 ashmaroli