forestryio / forestry.io Goto Github PK

View Code? Open in Web Editor NEW

279.0 11.0 174.0 668.3 MB

Forestry.io website

Home Page: https://forestry.io

JavaScript 20.33% HTML 47.74% CSS 31.14% Vim Snippet 0.78%

hugo forestry jamstack cms

forestry.io's People

Contributors

Stargazers

Watchers

Forkers

nick341 joshed-io davidpatrick bengchet cavain orangecig emperor-vlad020 kit-walker tehuel trevorburnham kruebling stuartstephens ntmp maiki itsnwa ncphillips airnowater eddiemoore feyisayo tiagoorganizze chrisdmacrae organizationdummy itsbetasite tuchang regisphilibert jpking10 aborruso bsde1234 jperdochqu dcacik jamesvibar kolaente ahmedash95 megrasaurousrex vys solugebefola andy-forestry akshatkedia charlie-cao myubi eci orf53975 anantgarg jonathanredford cdotly livinfree rob-jefferson madeofstars0 documentation-without-paper 99hats rv-bsnyder ilessing vinum sudoist dikshants1 davidrojasleon adar-raviv mitchmac lyellr radusuciu northernthaiescape jveitchmichaelis bclonan simplerethink rwhytsell stevepereira 0xyittle mimonirbd sagakom alan247 test4est21 wardyment dshanley jnanadarshan jeffsee55 yoanyombapro1234 jamiemccarville jasmith86 danmonahan ravivalluri yaaax zdamao glittle averysmithproductions namoda378 bilal4 sarah6781 sohelahmed7 ahma3 jwarner112 chungtv woosterinitiative jdtzmn brahmanya lewisjared rschacherl astanoszek ladifire brandlewco alaincoletta

forestry.io's Issues

New starter submission

👋 Hi, I'd like to submit a new theme successfully tested on Forestry:

name: The butler
preview: https://demo.cecil.app/
image: https://raw.githubusercontent.com/Cecilapp/starter-blog/master/static/images/cecil-preview.png
author: Arnaud Ligny
  versions:
  - name: Cecil
    repo: https://github.com/Cecilapp/starter-blog
    branch: master
  textline: A ready to use static blog, powered by Cecil and Hyde.

Submission checklist

Make sure to setup up things in Forestry:

Import is complete
Sidebar sections are visible
Media upload folder and public path are defined
Instant Previews are working

Problem we're trying to solve

We need to properly set up the revue account for the Forestry newsletter.

Showcase: Adding a new site

I built a new site for our branding/marketing agency.

I was wondering if I could submit it to the Forestry Showcase.

The site is: https://better.agency.

Thanks,
Nathan :)

Problems we're trying to solve

The existing docs need to be ported and refactored to the new front matter model. We also need to simplify the complex docs templates front-matter-fields to be basic markdown for ease-of-us.

We also want to improve the flow and organization of the docs, and will need to set up aliases to handle redirects.

[Doc] Hosting with BitBucket Pages

Problems we're trying to solve

BitBucket users may want to host using BitBucket pages. There is limited documentation on this, so providing it will be helpful, and would provide a good piece of content to promote.

Jobs to be done

Explain advantages and disadvantages
Explain username.bitbucket.io
- Explain that a URL-safe username is required
Explain setting up a cname file for a custom domain
Explain BitBucket hosting option

Pharmaseal.co showcase request

Hi @teamforestry

Just thought I'd drop a request to get Pharmaseal listed within the showcase on Forestry. They've been showcased previously on HUGO and they're great believers in the Forestry CMS.

We'd love to see them on Forestry, and they're really making waves in the pharmaceutical industry. If you require any media/mockups from our side, please drop me a message on Slack @jono

Showcase submission

Title: Hapticmedia Blog
Image: Click 📸
Permalink: https://hapticmedia.fr/blog/en/

We would be happy to contribute to spreading Forestry.io into the world (as we did for GoHugo) 🙏

CC @DirtyF

`npm start` error

os: mac

➜  forestry.io git:(master) npm -version
6.4.1
➜  forestry.io git:(master) npm start

> [email protected] start /Users/tianou/forestry.io
> gulp server

[21:51:56] Failed to load external module @babel/register
[21:51:56] Requiring external module babel-register
assert.js:351
    throw err;
    ^

AssertionError [ERR_ASSERTION]: Task function must be specified
    at Gulp.set [as _setTask] (/Users/tianou/forestry.io/node_modules/undertaker/lib/set-task.js:10:3)
    at Gulp.task (/Users/tianou/forestry.io/node_modules/undertaker/lib/task.js:13:8)
    at Object.<anonymous> (/Users/tianou/forestry.io/gulpfile.babel.js:50:6)
    at Module._compile (internal/modules/cjs/loader.js:707:30)
    at loader (/Users/tianou/forestry.io/node_modules/babel-register/lib/node.js:144:5)
    at Object.require.extensions.(anonymous function) [as .js] (/Users/tianou/forestry.io/node_modules/babel-register/lib/node.js:154:7)
    at Module.load (internal/modules/cjs/loader.js:605:32)
    at tryModuleLoad (internal/modules/cjs/loader.js:544:12)
    at Function.Module._load (internal/modules/cjs/loader.js:536:3)
    at Module.require (internal/modules/cjs/loader.js:643:17)
npm ERR! code ELIFECYCLE
npm ERR! errno 1
npm ERR! [email protected] start: `gulp server`
npm ERR! Exit status 1
npm ERR!
npm ERR! Failed at the [email protected] start script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

npm ERR! A complete log of this run can be found in:
npm ERR!     /Users/tianou/.npm/_logs/2018-11-20T13_51_57_983Z-debug.log

Can't save posts as drafts

I just hooked up my blog to Forestry, and I can's find an option to save newly created as drafts. they get committed to master directly.

"Write Better JavaScript With Webpack" - Content Improvements

Just wanted to discuss some possible content changes to a recent blog post:

1. AMD

Webpack supports two standards for Module configuration: EcmaScript and CommonJS.

Even if it's unfashionable these days, webpack does support AMD module syntax. I think there is some value in including a brief example and explanation.

2. `npm` scripts

{
    "name": "my-webpack-demo",
    ...
    "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1",
    "build": "./node_modules/webpack-cli/bin/webpack.js",
    "watch": "./node_modules/webpack-cli/bin/webpack.js --watch"
    },
    ...
}

A major advantage to using npm scripts is that we can use the namespace given to the cli tools, even if they're installed locally. Because when evaluating scripts, npm adds node_modules/.bin/ to the PATH environment variable. To highlight best practice, we can improve that snippet to read:

    "build": "webpack",
    "watch": "webpack --watch"

Forestry Integration

Problems we're trying to solve

Now that the site is built, we need to integrate with Forestry and add the content

Content

Set up

New starter submission

👋 Hi, I'd like to submit a new theme successfully tested on Forestry, since you finalized the Forestry config for me 😄

name: # Jamdocs
preview:# https://jamdocs.netlify.com/
author: # Samuel Horn af Rantzien
  versions:
  - name: Gridsome
    repo: https://github.com/samuelhorn/jamdocs
    branch: master
  textline: The ultimate static generated documentation theme for the JAM-stack. Highly customizable, based on Gridsome, preconfigured for Forestry, ready to deploy to Netlify in one click

New starter submission

👋 Hi, I'd like to submit a new theme successfully tested on Forestry:

name: # name of your starter 
preview:# URL of your starter live preview 
image: # Thumbnail URL
author: # name of the starter's author
  versions:
  - name: # SSG name (Gatsby, Gridsome, Hugo, Jekyll, VuePress, Next, Nuxt, etc.)
    repo: # public repo URL (https://github.com/username/repo
    branch: (optional) # e.g. forestry
  textline: # short description (blog, landing page, documentation, portfolio)

Submission checklist

Make sure to setup up things in Forestry:

Import is complete
Sidebar sections are visible
Media upload folder and public path are defined
Instant Previews are working

Deploying gem-based Jekyll theme connected to GitHub repo not working in all cases

I am seeing different behavior across different Jekyll sites. In one case, the site is able to use a gem-based theme pulled from GitHub, and in another case it is not. It appears as if the bundle init command isn't executing in the failed log. This very well could be on my shoulders.

A failing build log:

Failed to build site

Installing dependencies
02:55:55 PM: Started restoring cached node version
02:55:56 PM: Finished restoring cached node version
02:55:57 PM: v8.12.0 is already installed.
02:55:58 PM: Now using node v8.12.0 (npm v6.4.1)
02:55:58 PM: Attempting ruby version 2.3.6, read from environment
02:55:58 PM: Using ruby version 2.3.6
02:55:59 PM: Using PHP version 5.6
02:55:59 PM: Started restoring cached ruby gems
02:55:59 PM: Finished restoring cached ruby gems
02:55:59 PM: Started restoring cached go cache
02:55:59 PM: Finished restoring cached go cache
02:55:59 PM: 
02:55:59 PM: unset GOOS;
02:55:59 PM: unset GOARCH;
02:55:59 PM: export GOROOT='/opt/buildhome/.gimme/versions/go1.10.linux.amd64';
02:55:59 PM: export PATH="/opt/buildhome/.gimme/versions/go1.10.linux.amd64/bin:${PATH}";
02:55:59 PM: go version >&2;
02:55:59 PM: 
02:55:59 PM: export GIMME_ENV='/opt/buildhome/.gimme/env/go1.10.linux.amd64.env';
02:55:59 PM: go version go1.10 linux/amd64
02:55:59 PM: Installing missing commands
02:55:59 PM: Verify run directory
02:55:59 PM: Executing user command: jekyll build --config config-forestryio.yml --destination _forestry_site
02:55:59 PM: /opt/buildhome/.rvm/gems/ruby-2.3.6/gems/bundler-1.16.4/lib/bundler/source/git/git_proxy.rb:235:in `allowed_in_path': The git source git://github.com/funkfinger/growing-with-w-theme.git is not yet checked out. Please run `bundle install` before trying to start your application (Bundler::GitError)
02:55:59 PM: 	from /opt/buildhome/.rvm/gems/ruby-2.3.6/gems/bundler-1.16.4/lib/bundler/source/git/git_proxy.rb:192:in `find_local_revision'
02:55:59 PM: 	from /opt/buildhome/.rvm/gems/ruby-2.3.6/gems/bundler-1.16.4/lib/bundler/source/git/git_proxy.rb:64:in `revision'
02:55:59 PM: 	from /opt/buildhome/.rvm/gems/ruby-2.3.6/gems/bundler-1.16.4/lib/bundler/source/git.rb:225:in `revision'
02:55:59 PM: 	from /opt/buildhome/.rvm/gems/ruby-2.3.6/gems/bundler-1.16.4/lib/bundler/source/git.rb:93:in `install_path'
02:55:59 PM: 	from /opt/buildhome/.rvm/gems/ruby-2.3.6/gems/bundler-1.16.4/lib/bundler/source/path.rb:126:in `expanded_path'
02:55:59 PM: 	from /opt/buildhome/.rvm/gems/ruby-2.3.6/gems/bundler-1.16.4/lib/bundler/source/path.rb:163:in `load_spec_files'
02:55:59 PM: 	from /opt/buildhome/.rvm/gems/ruby-2.3.6/gems/bundler-1.16.4/lib/bundler/source/git.rb:200:in `load_spec_files'
02:55:59 PM: 	from /opt/buildhome/.rvm/gems/ruby-2.3.6/gems/bundler-1.16.4/lib/bundler/source/path.rb:100:in `local_specs'
02:55:59 PM: 	from /opt/buildhome/.rvm/gems/ruby-2.3.6/gems/bundler-1.16.4/lib/bundler/source/git.rb:167:in `specs'
02:55:59 PM: 	from /opt/buildhome/.rvm/gems/ruby-2.3.6/gems/bundler-1.16.4/lib/bundler/definition.rb:754:in `block in converge_locked_specs'
02:55:59 PM: 	from /opt/buildhome/.rvm/gems/ruby-2.3.6/gems/bundler-1.16.4/lib/bundler/definition.rb:740:in `each'
02:55:59 PM: 	from /opt/buildhome/.rvm/gems/ruby-2.3.6/gems/bundler-1.16.4/lib/bundler/definition.rb:740:in `converge_locked_specs'
02:55:59 PM: 	from /opt/buildhome/.rvm/gems/ruby-2.3.6/gems/bundler-1.16.4/lib/bundler/definition.rb:248:in `resolve'
02:55:59 PM: 	from /opt/buildhome/.rvm/gems/ruby-2.3.6/gems/bundler-1.16.4/lib/bundler/definition.rb:171:in `specs'
02:55:59 PM: 	from /opt/buildhome/.rvm/gems/ruby-2.3.6/gems/bundler-1.16.4/lib/bundler/definition.rb:238:in `specs_for'
02:55:59 PM: 	from /opt/buildhome/.rvm/gems/ruby-2.3.6/gems/bundler-1.16.4/lib/bundler/definition.rb:227:in `requested_specs'
02:55:59 PM: 	from /opt/buildhome/.rvm/gems/ruby-2.3.6/gems/bundler-1.16.4/lib/bundler/runtime.rb:108:in `block in definition_method'
02:55:59 PM: 	from /opt/buildhome/.rvm/gems/ruby-2.3.6/gems/bundler-1.16.4/lib/bundler/runtime.rb:20:in `setup'
02:55:59 PM: 	from /opt/buildhome/.rvm/gems/ruby-2.3.6/gems/bundler-1.16.4/lib/bundler.rb:107:in `setup'
02:55:59 PM: 	from /opt/buildhome/.rvm/gems/ruby-2.3.6/gems/bundler-1.16.4/lib/bundler/setup.rb:20:in `<top (required)>'
02:55:59 PM: 	from /opt/buildhome/.rvm/rubies/ruby-2.3.6/lib/ruby/site_ruby/2.3.0/rubygems/core_ext/kernel_require.rb:55:in `require'
02:55:59 PM: 	from /opt/buildhome/.rvm/rubies/ruby-2.3.6/lib/ruby/site_ruby/2.3.0/rubygems/core_ext/kernel_require.rb:55:in `require'
02:55:59 PM: 	from /opt/buildhome/cache/binstubs/jekyll:27:in `<main>'
02:55:59 PM: Caching artifacts
02:55:59 PM: Started saving ruby gems
02:55:59 PM: Finished saving ruby gems
02:55:59 PM: Started saving pip cache
02:55:59 PM: Finished saving pip cache
02:55:59 PM: Started saving emacs cask dependencies
02:55:59 PM: Finished saving emacs cask dependencies
02:55:59 PM: Started saving maven dependencies
02:55:59 PM: Finished saving maven dependencies
02:55:59 PM: Started saving boot dependencies
02:55:59 PM: Finished saving boot dependencies
02:56:00 PM: Started saving go dependencies
02:56:00 PM: Finished saving go dependencies
02:56:00 PM:

a successful build log:

Installing dependencies
08:08:20 PM: Downloading and installing node v8.12.0...
08:08:21 PM: Downloading https://nodejs.org/dist/v8.12.0/node-v8.12.0-linux-x64.tar.xz...
08:08:21 PM: 
                                                                          0.9%
##                                                                         4.1%
###########                                                               16.4%
########################                                                  34.6%
#######################################                                   54.6%
#######################################################                   76.8%
######################################################################## 100.0%
08:08:22 PM: Computing checksum with sha256sum
08:08:22 PM: Checksums matched!
08:08:22 PM: Now using node v8.12.0 (npm v6.4.1)
08:08:24 PM: Attempting ruby version 2.3.6, read from environment
08:08:24 PM: Using ruby version 2.3.6
08:08:24 PM: Using PHP version 5.6
08:08:25 PM: Started restoring cached ruby gems
08:08:25 PM: Finished restoring cached ruby gems
08:08:25 PM: Installing gem bundle
08:08:25 PM: The git source `git://github.com/funkfinger/vigor-cms-theme.git` uses the `git` protocol, which transmits data without encryption. Disable this warning with `bundle config git.allow_insecure true`, or switch to the `https` protocol to keep your data secure.
08:08:25 PM: Fetching git://github.com/funkfinger/vigor-cms-theme.git
08:08:25 PM: The dependency tzinfo-data (>= 0) will be unused by any of the platforms Bundler is installing for. Bundler is installing for ruby but the dependency is only for x86-mingw32, x86-mswin32, x64-mingw32, java. To add those platforms to the bundle, run `bundle lock --add-platform x86-mingw32 x86-mswin32 x64-mingw32 java`.
08:08:25 PM: Fetching gem metadata from https://rubygems.org/...........
08:08:28 PM: Fetching gem metadata from https://rubygems.org/.
08:08:28 PM: Resolving dependencies...
08:08:28 PM: Fetching public_suffix 3.0.3
08:08:28 PM: Installing public_suffix 3.0.3
08:08:28 PM: Fetching addressable 2.5.2
08:08:28 PM: Installing addressable 2.5.2
08:08:28 PM: Fetching execjs 2.7.0
08:08:28 PM: Installing execjs 2.7.0
08:08:28 PM: Fetching autoprefixer-rails 9.1.4
08:08:28 PM: Installing autoprefixer-rails 9.1.4
08:08:28 PM: Fetching popper_js 1.14.3
08:08:28 PM: Installing popper_js 1.14.3
08:08:28 PM: Fetching rb-fsevent 0.10.3
08:08:28 PM: Installing rb-fsevent 0.10.3
08:08:28 PM: Fetching ffi 1.9.25
08:08:28 PM: Installing ffi 1.9.25 with native extensions
08:08:28 PM: Fetching rb-inotify 0.9.10
08:08:34 PM: Installing rb-inotify 0.9.10
08:08:34 PM: Fetching sass-listen 4.0.0
08:08:34 PM: Installing sass-listen 4.0.0
08:08:34 PM: Fetching sass 3.5.7
08:08:34 PM: Installing sass 3.5.7
08:08:35 PM: Fetching bootstrap 4.0.0
08:08:35 PM: Installing bootstrap 4.0.0
08:08:35 PM: Using bundler 1.16.4
08:08:35 PM: Fetching colorator 1.1.0
08:08:35 PM: Installing colorator 1.1.0
08:08:35 PM: Fetching concurrent-ruby 1.0.5
08:08:35 PM: Installing concurrent-ruby 1.0.5
08:08:35 PM: Fetching eventmachine 1.2.7
08:08:35 PM: Installing eventmachine 1.2.7 with native extensions
08:08:35 PM: Fetching http_parser.rb 0.6.0
08:08:45 PM: Installing http_parser.rb 0.6.0 with native extensions
08:08:45 PM: Fetching em-websocket 0.5.1
08:08:46 PM: Installing em-websocket 0.5.1
08:08:46 PM: Fetching forwardable-extended 2.6.0
08:08:46 PM: Installing forwardable-extended 2.6.0
08:08:46 PM: Fetching htmlentities 4.3.4
08:08:46 PM: Installing htmlentities 4.3.4
08:08:46 PM: Fetching i18n 0.9.5
08:08:46 PM: Installing i18n 0.9.5
08:08:46 PM: Fetching jekyll-sass-converter 1.5.2
08:08:46 PM: Installing jekyll-sass-converter 1.5.2
08:08:46 PM: Fetching ruby_dep 1.5.0
08:08:46 PM: Installing ruby_dep 1.5.0
08:08:46 PM: Fetching listen 3.1.5
08:08:46 PM: Installing listen 3.1.5
08:08:46 PM: Fetching jekyll-watch 2.0.0
08:08:46 PM: Installing jekyll-watch 2.0.0
08:08:46 PM: Fetching kramdown 1.17.0
08:08:46 PM: Installing kramdown 1.17.0
08:08:47 PM: Fetching liquid 4.0.0
08:08:47 PM: Installing liquid 4.0.0
08:08:47 PM: Fetching mercenary 0.3.6
08:08:47 PM: Installing mercenary 0.3.6
08:08:47 PM: Fetching pathutil 0.16.1
08:08:47 PM: Installing pathutil 0.16.1
08:08:47 PM: Fetching rouge 3.2.1
08:08:47 PM: Installing rouge 3.2.1
08:08:47 PM: Fetching safe_yaml 1.0.4
08:08:47 PM: Installing safe_yaml 1.0.4
08:08:47 PM: Fetching jekyll 3.8.3
08:08:47 PM: Installing jekyll 3.8.3
08:08:47 PM: Fetching jekyll-feed 0.11.0
08:08:47 PM: Installing jekyll-feed 0.11.0
08:08:47 PM: Fetching jekyll-menus 0.6.0
08:08:47 PM: Installing jekyll-menus 0.6.0
08:08:47 PM: Fetching jekyll-redirect-from 0.14.0
08:08:47 PM: Installing jekyll-redirect-from 0.14.0
08:08:47 PM: Fetching jekyll-seo-tag 2.5.0
08:08:47 PM: Installing jekyll-seo-tag 2.5.0
08:08:48 PM: Fetching jekyll-sitemap 1.2.0
08:08:48 PM: Installing jekyll-sitemap 1.2.0
08:08:48 PM: Fetching jekyll_pages_api 0.1.6
08:08:48 PM: Installing jekyll_pages_api 0.1.6
08:08:48 PM: Fetching jekyll_pages_api_search 0.5.0
08:08:48 PM: Installing jekyll_pages_api_search 0.5.0
08:08:48 PM: Using vigor-cms-theme 0.0.8 (was 0.0.5) from git://github.com/funkfinger/vigor-cms-theme.git (at master@8193b0e)
08:08:48 PM: Bundle complete! 8 Gemfile dependencies, 39 gems now installed.
08:08:48 PM: Bundled gems are installed into `/opt/buildhome/cache/bundle`
08:08:48 PM: Post-install message from sass:
08:08:48 PM: 
08:08:48 PM: Ruby Sass is deprecated and will be unmaintained as of 26 March 2019.
08:08:48 PM: 
08:08:48 PM: * If you use Sass as a command-line tool, we recommend using Dart Sass, the new
08:08:48 PM:   primary implementation: https://sass-lang.com/install
08:08:48 PM: 
08:08:48 PM: * If you use Sass as a plug-in for a Ruby web framework, we recommend using the
08:08:48 PM:   sassc gem: https://github.com/sass/sassc-ruby#readme
08:08:48 PM: 
08:08:48 PM: * For more details, please refer to the Sass blog:
08:08:48 PM:   http://sass.logdown.com/posts/7081811
08:08:48 PM: 
08:08:48 PM: Gem bundle installed
08:08:48 PM: Started restoring cached go cache
08:08:48 PM: Finished restoring cached go cache
08:08:48 PM: 
08:08:48 PM: unset GOOS;
08:08:48 PM: unset GOARCH;
08:08:48 PM: export GOROOT='/opt/buildhome/.gimme/versions/go1.10.linux.amd64';
08:08:48 PM: export PATH="/opt/buildhome/.gimme/versions/go1.10.linux.amd64/bin:${PATH}";
08:08:48 PM: go version >&2;
08:08:48 PM: 
08:08:48 PM: export GIMME_ENV='/opt/buildhome/.gimme/env/go1.10.linux.amd64.env';
08:08:48 PM: go version go1.10 linux/amd64
08:08:48 PM: Installing missing commands
08:08:48 PM: Verify run directory
08:08:48 PM: Executing user command: jekyll build --config config-forestryio.yml --destination _forestry_site
08:08:48 PM: Configuration file: config-forestryio.yml
08:08:48 PM:             Source: /opt/buildhome/repo
08:08:48 PM:        Destination: _forestry_site
08:08:48 PM:  Incremental build: disabled. Enable with --incremental
08:08:48 PM:       Generating... 
08:08:48 PM: jekyll_pages_api_search: checking for Node.js: v8.12.0
08:08:48 PM:        Jekyll Feed: Generating feed for posts
08:08:48 PM:                     done in 1.283 seconds.
08:08:50 PM:  Auto-regeneration: disabled. Use --watch to enable.
08:08:50 PM: Caching artifacts
08:08:50 PM: Started saving ruby gems
08:08:50 PM: Finished saving ruby gems
08:08:50 PM: Started saving pip cache
08:08:50 PM: Finished saving pip cache
08:08:50 PM: Started saving emacs cask dependencies
08:08:50 PM: Finished saving emacs cask dependencies
08:08:50 PM: Started saving maven dependencies
08:08:50 PM: Finished saving maven dependencies
08:08:50 PM: Started saving boot dependencies
08:08:50 PM: Finished saving boot dependencies
08:08:50 PM: Started saving go dependencies
08:08:50 PM: Finished saving go dependencies
08:08:50 PM: Cached node version v8.12.0
08:08:50 PM:

Feature request: disable draft mode

I would like the ability to disable draft mode and publish with one-click as it simplifies my editing.

Test SEO configuration

test

Docs: add Netlify as deploy option?

hi! was browsing the docs https://forestry.io/docs/hosting/ and realized they dont include Netlify as an option. would you be open to a PR adding it? any preferred format or pointers that you might want to include?

Preview Site option should be available in the dashboard and sidebar

Currently, preview icon is only shown when editing a post. It should be available in Dashboard and Edit Sidebar.

Document build pipeline

Problem we're trying to solve

The build pipeline for this site is somewhat complex. Decent documentation would be good.

Document circleci
Document aws config
Document env vars (ALGOLIA, etc)

[Doc] Hosting with GitHub Pages

Problem's we're trying to solve

Setting up hosting with GitHub pages can be very confusing, depending on whether you're using Jekyll w/ GitHub pages, or allowing Forestry to generate your site.

Jobs to be done

Explain GitHub pages advantages and disadvantages
Explain GitHub pages setup with Forestry deploys
- Explain gh-pages branch
- Explain GitHub hosting option
Explain setting up a cname file for a custom domain
Link to relevant GitHub pages documentation

[Github Pages][Hugo] Custom domain not being respected by Forestry

This happens with Hugo sites. Github Pages puts the CNAME folder in the root of the project, but Hugo doesn't copy files from the root to the built site. All you need to do is put the CNAME in the static directory.

Add HTMLProofer to CircleCI pipeline

Problems we're trying to solve

Most SEO and site issues are caused by mistakes, or a failure to remember to do something. Most SEO agencies solve this with exhaustive checklists.

Given that we're a static site, we can use the tool html-proofer to check for all of these common mistakes for us at the time of deploy, and work to fix them as we find them.

Run htmlproofer to ensure that there are no html issues

HTMLProofer

Images

Whether all your images have alt tags
Whether your internal image references are not broken
Whether external images are showing
Whether your images are HTTP

Scripts

Whether your internal script references are working
Whether external scripts are loading
Whether CORS/SRI is enabled

Favicon

Whether your favicons are valid

HTML

Whether your HTML markup is valid. This is done via Nokogiri to ensure well-formed markup.

Others

check_opengraph
log_level: fatal
:cache: :timeframe => '30d'

Forestry Starter Vue

👋 Hi, I'd like to submit a new theme successfully tested on Forestry:

name: # name of your starter 
preview:# URL of your starter live preview 
image: # Thumbnail URL
author: # name of the starter's author
  versions:
  - name: # SSG name (Gatsby, Gridsome, Hugo, Jekyll, VuePress, Next, Nuxt, etc.)
    repo: # public repo URL (https://github.com/username/repo
    branch: (optional) # e.g. forestry
  textline: # short description (blog, landing page, documentation, portfolio)

Submission checklist

Make sure to setup up things in Forestry:

Import is complete
Sidebar sections are visible
Media upload folder and public path are defined
Instant Previews are working

How to download Build Files (artifacts)

Currently, we can publish to FTP, but what if I need to download the build files and upload manually? There is no option. now.

Please add an option to download Build Files as ZIP.

Setup and configure CircleCI

Problems we're trying to solve

Our build pipeline requires gulp to be run to update the algolia indexes. Since we already use CircleCI, we'll configure deployment w/ our build image.

We can also get free testing out of this, to ensure we never ship a bad page.

Basic deployment to S3
Update S3/Cloudfront redirects from a config file
Invalid Cloudfront cache based on checksum
Run stylelint - [Moved to prepush]
Run eslint - [Moved to prepush]

Why cannot get the docs side bar?

Hello,
I ran local development server: npm start but on below location docs siderbar not appear
https://pastebin.com/YEq9zZiP
https://pastebin.com/u0114ySM

http://localhost:3000/docs/welcome/

But on hosted website

(please note but also possible go to subpages by entering url manually ex: http://localhost:3000/docs/git-sync/github/
the only problem sidebar interface not appear)

Any help for fix?

New starter submission

👋 Hi, I'd like to submit a new theme successfully tested on Forestry:

name: # name of your starter 
preview:# URL of your starter live preview 
image: # Thumbnail URL
author: # name of the starter's author
  versions:
  - name: # SSG name (Gatsby, Gridsome, Hugo, Jekyll, VuePress, Next, Nuxt, etc.)
    repo: # public repo URL (https://github.com/username/repo
    branch: (optional) # e.g. forestry
  textline: # short description (blog, landing page, documentation, portfolio)

Submission checklist

Make sure to setup up things in Forestry:

Import is complete
Sidebar sections are visible
Media upload folder and public path are defined
Instant Previews are working

[Doc] Quick Start

Problems we're trying to solve

Right now users have expressed that getting started with Forestry is very hard if you don't already have a site to manage. Considering, we want to put together a quick start guide that will get a potential user into the app and using Forestry.

Goals

Get them to import a site from their own repo
Explain how to add new content
Explain how to add new sections (Hugo)
Explain setting up Front Matter Templates

Docs: "Creating new gemfile" instructions wipes existing site

https://forestry.io/docs/troubleshooting/could-not-locate-gemfile-or-bundle-directory/#adding-a-gemfile-to-an-existing-project

The instructions for creating a new Gemfile on an existing site resets a whole bunch of stuff to default. This isn't exactly desired behaviour and the docs explicitly mention an existing project:

Adding a Gemfile to an existing project

In our opinion the easiest way to add a Gemfile to a project is to have Jekyll generate the Gemfile for you, then commit that file to your project repo and push it to your source provider. To achieve you’ll need to:

...

This is the dangerous command:

# this command will generate a template Gemfile,
# calculate the dependency graph and install the
# dependencies with bundler
jekyll new . --force

I think better instructions would be to manually create a Gemfile with:

source "https://rubygems.org"

gem "jekyll"

(and customise as per https://jekyllrb.com/docs/ruby-101/) then run bundle install and commit the Gemfile and lock.

Add contributing guidelines

Problems we're trying to solve

We want to publish a public version of this repository (only updated by CircleCI when changes are pushed to the private repository) that people can use to:

Suggest changes to docs
Suggest changes to blog posts
Submit issues
Submit showcase websites
Add contributing guidelines
Add license (closed-source, belongs to us)
Add issue template

Issue template

<!--
If you are opening a new issue, please ensure that it isn't already an open issue about this topic already. 

You can do this by searching the issues for this repository:
https://github.com/forestryio/forestry.io-private/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+{{YOUR TOPIC}}

Use the options below to provide key information for this issue:
-->

**- Do you want to request a *feature*, report a *bug*, or submit a website to the *showcase*?**

<!-- FEATURES ONLY: don't fill this out if it is not a feature -->

<!-- BUGS ONLY: don't fill this out if it is not a bug -->
**- What is the current behavior?**

**- If the current behavior is a bug, please provide the steps to reproduce.**

**- What is the behaviour you expect?**

<!-- SHOWCASE ONLY: don't fill this out if it is not a showcase submission -->
**- What is your website's URL?**

**- Is this a personal or commercial website?**

**- Are you the owner or maintainer of this website?**

**- What is your site's ID in Forestry?**
<!-- This can be found in the URL for the site: https://app.forestry.io/sites/{{ SITE_ID }}/

**- Provide the screenshot or `.gif` you'd like us to use (OPTIONAL)**

11myesbos

👋 Hi, I'd like to submit a new theme successfully tested on Forestry:

name: # name of your starter 
preview:# URL of your starter live preview 
image: # Thumbnail URL
author: # name of the starter's author
  versions:
  - name: # SSG name (Gatsby, Gridsome, Hugo, Jekyll, VuePress, Next, Nuxt, etc.)
    repo: # public repo URL (https://github.com/username/repo
    branch: (optional) # e.g. forestry
  textline: # short description (blog, landing page, documentation, portfolio)

Submission checklist

Make sure to setup up things in Forestry:

Import is complete
Sidebar sections are visible
Media upload folder and public path are defined
Instant Previews are working

Quotes being added to integer values in config

I'm using jekyll-paginate and there is an integer-based configuration value. When saving this via the Forestry config, it converts the value into a string and breaks pagination on my site.

[Doc] Hosting with GitLab pages

Problem's we're trying to solve

Create a hosting doc that explains how to set up GitLab page's with Forestry.

This will allow GitLab users to easily host their site w/o having to use a service like Netlify

Jobs to be done

Explain advantages and disadvantages
Explain setting up GitLab CI w/ built-in templates
Explain setting up an A record for a root domain
Explain setting up a CNAME for a subdomain
Explain environments and deployment rollback
Explain adding an SSL certificate from Let's Encrypt for HTTPs
Link to relevant GitLab documentation

Feature request: Side menu bookmarks

I have a blog like site with hundreds of articles that are organized by categories (or tags). When I edit the magazine it's helpful to be able to navigate quickly to the articles or each category from the side menu.

The section functionality does not fit this use case as I can only filter by the file name.

I suggest adding the ability to filter by the fields in the search box (e.g. tags:sport) and be able to bookmark this search in the side menu. This way the user can create many views that fit his workflows.

New starter submission

👋 Hi, I'd like to submit a new theme successfully tested on Forestry:

name: # name of your starter 
preview:# URL of your starter live preview 
image: # Thumbnail URL
author: # name of the starter's author
  versions:
  - name: # SSG name (Gatsby, Gridsome, Hugo, Jekyll, VuePress, Next, Nuxt, etc.)
    repo: # public repo URL (https://github.com/username/repo
    branch: (optional) # e.g. forestry
  textline: # short description (blog, landing page, documentation, portfolio)

Submission checklist

Make sure to setup up things in Forestry:

Import is complete
Sidebar sections are visible
Media upload folder and public path are defined
Instant Previews are working

[Blog] Adding HTTPs and a CDN to GitHub, GitLab, and BitBucket pages with CloudFront

Problems we're trying to solve

One of the main disadvantages to using a Git provider's page tool is that you can't easily get SSL for a custom domain. This can be solved by proxying your site through Amazon Cloudfront, and gives you the full power of Lamda@edge as well.

Jobs to be done

Explain why SSL is important
Explain automatic setup with a CloudFormation stack
Cover setting up the AWSCLI for updating your stack
Explain adding a lamda@edge function to handle redirects
Explain how to set this up with Forestry (other blog posts)

S3 setup needs updating

https://forestry.io/docs/hosting/amazon-s3/#setting-up-user-permissions

Screenshots and instructions are out of date.

New starter submission

👋 Hi, I'd like to submit a new theme successfully tested on Forestry:

name: # name of your starter 
preview:# URL of your starter live preview 
image: # Thumbnail URL
author: # name of the starter's author
  versions:
  - name: # SSG name (Gatsby, Gridsome, Hugo, Jekyll, VuePress, Next, Nuxt, etc.)
    repo: # public repo URL (https://github.com/username/repo
    branch: (optional) # e.g. forestry
  textline: # short description (blog, landing page, documentation, portfolio)

Submission checklist

Make sure to setup up things in Forestry:

Import is complete
Sidebar sections are visible
Media upload folder and public path are defined
Instant Previews are working

New starter submission

👋 Hi, I'd like to submit a new theme successfully tested on Forestry:

name: # name of your starter 
preview:# URL of your starter live preview 
image: # Thumbnail URL
author: # name of the starter's author
  versions:
  - name: # SSG name (Gatsby, Gridsome, Hugo, Jekyll, VuePress, Next, Nuxt, etc.)
    repo: # public repo URL (https://github.com/username/repo
    branch: (optional) # e.g. forestry
  textline: # short description (blog, landing page, documentation, portfolio)

Submission checklist

Make sure to setup up things in Forestry:

Import is complete
Sidebar sections are visible
Media upload folder and public path are defined
Instant Previews are working

Steps to deploy

Please give steps to deploy locally and in firebase

[Docs] Properly document how GitHub Pages CNAME file works in conjunction w/ settings

@jamespohalloran commented on Mon Jan 08 2018

Repo Issue

Current Behaviour

Setting auto-deploy to true in Forestry clear the Github-pages custom domain inside the Github repo's settings. Causes the live site to give a 404.

Expected Behaviour

Steps to reproduce

Setup a github pages site. Give it a custom domain.
Import the site into forestry, and toggle auto-deploy to true.
The custom domain in github-pages will change to ""

Other Info (Optional)

@jpatters commented on Wed Jan 10 2018

@jamespohalloran let me guess, it's a hugo site? You should put the file in the static directory so that it gets built into your site.

Submitting our Foresty Site.

Better, a creative and digital agency, have launched their new site https://better.agency/ built with Forestry.io

New starter submission

👋 Hi, I'd like to submit a new theme successfully tested on Forestry:

name: # name of your starter 
preview:# URL of your starter live preview 
  image: # Thumbnail 
  versions:
  - name: # SSG name (Gatsby, Gridsome, Hugo, Jekyll, VuePress, Next, Nuxt, etc.)
    repo: # public repo URL
    branch: (optional)
  textline: # Short description (blog, landing page, documentation, portfolio)

Submission checklist

Import is complete
Sidebar sections are visible
Media upload folder and public path are defined
Instant Previews are working

New starter submission

👋 Hi, I'd like to submit a new theme successfully tested on Forestry:

name: # Meghna 
preview:# http://demo.themefisher.com/meghna-hugo/en/
image: # https://gethugothemes.com/wp-content/uploads/edd/2019/07/Megna.jpg
author: # Themefisher
  versions:
  - name: Hugo
    repo: # https://github.com/themefisher/meghna-hugo
    branch: master
  textline: # Onepage Business Hugo Theme

Submission checklist

Make sure to setup up things in Forestry:

Import is complete
Sidebar sections are visible
Media upload folder and public path are defined
Instant Previews are working

[Doc] Hosting with GitHub Pages; allowing GitHub to build your site

Problem's we're trying to solve

Some users use the Jekyll build feature of GitHub pages to deploy their site. This shouldn't be the primary method of hosting when using Forestry, but we should still provide context for users who wish to do this.

Jobs to be done

Explain advantages and disadvantages
Explain Commit to source hosting option
Explain github-pages gem
Explain Whitelisted GitHubs plugins
Explain Whitelisted GitHub pages themes
Explain remote themes
Explain using a cname for a custom domain

themefisher / kross-hugo

👋 Hi, I'd like to submit a new theme successfully tested on Forestry:

name: Kross
preview: https://themes.gohugo.io/theme/kross-hugo-portfolio-template/
image: https://d33wubrfki0l68.cloudfront.net/0cc5d95c5befca16a8f14b0d67197c5c1696db46/c2737/kross-hugo-portfolio-template/screenshot-kross-hugo-portfolio-template_hua1726dc50382dc8979d1f90fa43be446_229423_1500x1000_fill_catmullrom_top_2.png
author: Themefisher
  versions:
  - name: Hugo
    repo:https://github.com/themefisher/kross-hugo-portfolio-template
    branch: (optional) # e.g. forestry
  textline: Portfolio

Submission checklist

Make sure to setup up things in Forestry:

Import is complete
Sidebar sections are visible
Media upload folder and public path are defined
Instant Previews are working

"Where are my videos?"/"Why can't I upload videos?"

config.toml

Im having trouble connecting my config.toml file to forestry.

heres my folder structure thats connected to git

but when i enter the config path sawmill-starter/
its says Cannot find config file in specified path.
and the same when i try forestry/

Cleanup

Problems we're trying to solve

In integrating with Hugo, some things needed to be changed/updated. @itsnwa should review! :)

Homepage

Updated the hero to be full-height and moved illustration down on mobile (just played around w/ this -- if we don't like it I can revert it quickly)
Updated testimonials on mobile to scroll so that our mobile score doesn't take a hit

Nav

Added logged in state
Added search to blog and docs

Search

Search needs styling improvements
Templates for search can be found at hugo/layouts/partials/search.html and in src/js/imports/algoliaSearch/templates/. Updating the JS mustache templates requires you to restart the dev server 👎
Algolia logo needs to remain front and center for licensing reasons

Blog

Added related posts to blog posts -- this needs styling improvement so it's easy to differentiate them from the main article! 👍
Added about Forestry section
Added link to author articles to author section
Added link to last commit on posted date
Added edit on GitHub CTA to page
Added social sharing because we're focusing on growth
Clean up the related posts?

Docs

Added last modified time to page
Added edit on GitHub CTA to page
The change the navbar can feel pretty jarring
- Can the navbar be the same width as the docs everywhere? (better than making the docs layout smaller)

Showcase

Added a drafted example of a website showcase page

Support

Added a support page
Added input styling to textarea and select field for support form
Added support form (submits results as an intercom conversation)
- Added basic table styling for the support page

Refactored to ES6 w/ webpack
Removed jQuery dependency

CSS

Linted and cleaned by pettier & stylelint

forestryio / forestry.io Goto Github PK

forestry.io's People

Contributors

Stargazers

Watchers

Forkers

forestry.io's Issues

Submission checklist

Problem we're trying to solve

Problems we're trying to solve

Problems we're trying to solve

Jobs to be done

1. AMD

2. npm scripts

Problems we're trying to solve

Content

Set up

Submission checklist

Problem we're trying to solve

Problem's we're trying to solve

Jobs to be done

Problems we're trying to solve

HTMLProofer

Images

Links

Scripts

Favicon

HTML

Others

Submission checklist

Problems we're trying to solve

Submission checklist

Problems we're trying to solve

Goals

Problems we're trying to solve

Issue template

Submission checklist

Problem's we're trying to solve

Jobs to be done

Submission checklist

Problems we're trying to solve

Jobs to be done

Submission checklist

Submission checklist

Current Behaviour

Expected Behaviour

Steps to reproduce

Other Info (Optional)

Submission checklist

Submission checklist

Problem's we're trying to solve

Jobs to be done

Submission checklist

Problems we're trying to solve

Homepage

Nav

Search

Blog

Docs

Showcase

Support

Recommend Projects

Recommend Topics

Recommend Org

2. `npm` scripts