getnikola / nikola-netlify-cms Goto Github PK

Some frontmatter data listed in the Nikola documentation are not available through the Netlify CMS editor due to being missing from the config.yml file. They are: hidetitle, updated, author, status, link, template, type, pretty_url, nocomments, hyphenate, has_math. Some of these might not be needed for a general audience but some (for example author) could be included.

I'm not sure about the cause of this but I suspect it's caused by the link. Currently the button links to:
https://app.netlify.com/start/deploy?repository=https://github.com/getnikola/nikola-netlify-cms&scheme=cms

In the examples of other templates I see that the link ends with "&stack=cms" instead of "&scheme=cms". I don't if this is the cause but I can't think of anything else.

When adding a new post or page through Netlify CMS admin, the buttons read "New Posts" and "New Pages". To fix this, the label_singular setting can be used, as in:

collections:
  - name: "pages"
    label: "Pages"
    label_singular: "Page"

Wouldn't it be better to explicitly match the frontmatter format used by both Nikola and Netlify CMS? At the moment, these are unset on both sides. Setting METADATA_FORMAT to "YAML" in Nikola conf.py and "format: yaml-frontmatter" in files/admin/config.yml for both posts and pages would be safer, in my opinion.

When that is done, the "tags" field could also be set to use the "list" widget instead of the "string" widget. And I think that the "text" widget might be better suited for the "description" field.

If I'm not mistaken, the Python 3.6 runtime is no longer available on Netlify and the deployment fails. The runtime.txt file should be updated.

As a side note, I don't know how important this is, but the requirements file lists the Nikola dependency as version 8.0.1. As of this writing the current version is 8.0.4. Other pinned dependencies can also be outdated.

The admin page (files/admin/index.html) includes a stylesheet link to https://unpkg.com/netlify-cms@latest/dist/cms.css. That file has the following contents:

/**
 * Netlify CMS 2.0 moved from static CSS to CSS-in-JS. Some site builds are configured to look
 * for `cms.css`, and will break when it's missing, so we're putting out this blank file to help.
 * We'll eventually remove it, so please update your build to not require it.
 */

I tried to build a site with this repo and got the following error when I added ipynb files.

I added notebook==6.0.3 to requirements.txt and it worked fine.

My question (or suggestion) is whether "notebook==6.0.3" be added to requirements by default? My personal opinion is yes, because:

1. Not many are tech savvy or have time/resources to figure out what needs to be done to publish ipynb files.
2. In my opinion, one of the main USPs of Nikola compared to other SSGs is it's ability to publish Jupyter notebooks without users having to convert them to markdown. Why not extend the same convenience when using Netlify or GitLab? I raised the same issue there in Gitlab but having got no response, I had to create a new docker image for Nikola as the existing one fails. I am personally happy with it because, in the process, I learned yaml and building docker images. But I don't think many end users are like that. Most follow documentation, and if it works then fine, else raise an issue and when it doesn't get addressed, they move on elsewhere. I believe that little fixes like these could create a big impact on users by making things easier for them. I really like Nikola and so far, it's the best SSG for me. I want others to feel that way too.

However, if you feel that "notebook==6.0.3" should not be added to requirements by default, could you please mention in Readme that users add this requirement while publishing Jupyter notebooks?