diff mbox series

[qemu-web] Document how to test the site with jekyll locally

Message ID 20181128153526.10948-1-berrange@redhat.com
State New
Headers show
Series [qemu-web] Document how to test the site with jekyll locally | expand

Commit Message

Daniel P. Berrangé Nov. 28, 2018, 3:35 p.m. UTC 
Add a README file that tells people this is a jekyll based static
website, and shows people how to run jekyll for testing purposes.

Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
---

NB, we should really mention a license in the README too, but I don't
see info about what license we consider qemu-web to be covered by...

 README      | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 _config.yml |  2 ++
 2 files changed, 55 insertions(+)
 create mode 100644 README

Comments

Paolo Bonzini Nov. 28, 2018, 4:44 p.m. UTC | #1 
On 28/11/18 16:35, Daniel P. Berrangé wrote:
> Add a README file that tells people this is a jekyll based static
> website, and shows people how to run jekyll for testing purposes.
> 
> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
> ---
> 
> NB, we should really mention a license in the README too, but I don't
> see info about what license we consider qemu-web to be covered by...

    47	Paolo Bonzini <pbonzini@redhat.com>
    44	Michael Roth <mdroth@linux.vnet.ibm.com>
    13	Thomas Huth <thuth@redhat.com>
     3	Eric Blake <eblake@redhat.com>
     2	Daniel P. Berrange <berrange@redhat.com>
     2	Jeff Cody <jcody@redhat.com>
     1	Alex Bennée <alex.bennee@linaro.org>
     1	Daniel P. Berrangé <berrange@redhat.com>
     1	Fam Zheng <famz@redhat.com>
     1	Rainer Müller <raimue@macports.org>
     1	Stefan Hajnoczi <stefanha@gmail.com>
     1	Yu Ning <yu.ning@intel.com>

Anybody (especially non-RH people) disagrees with dual-license CC-BY-SA
4.0 and GPLv2+?  (So that we can copy from blog posts to manuals)?

Paolo
Daniel P. Berrangé Nov. 28, 2018, 4:47 p.m. UTC | #2 
On Wed, Nov 28, 2018 at 05:44:09PM +0100, Paolo Bonzini wrote:
> On 28/11/18 16:35, Daniel P. Berrangé wrote:
> > Add a README file that tells people this is a jekyll based static
> > website, and shows people how to run jekyll for testing purposes.
> > 
> > Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
> > ---
> > 
> > NB, we should really mention a license in the README too, but I don't
> > see info about what license we consider qemu-web to be covered by...
> 
>     47	Paolo Bonzini <pbonzini@redhat.com>
>     44	Michael Roth <mdroth@linux.vnet.ibm.com>
>     13	Thomas Huth <thuth@redhat.com>
>      3	Eric Blake <eblake@redhat.com>
>      2	Daniel P. Berrange <berrange@redhat.com>
>      2	Jeff Cody <jcody@redhat.com>
>      1	Alex Bennée <alex.bennee@linaro.org>
>      1	Daniel P. Berrangé <berrange@redhat.com>
>      1	Fam Zheng <famz@redhat.com>
>      1	Rainer Müller <raimue@macports.org>
>      1	Stefan Hajnoczi <stefanha@gmail.com>
>      1	Yu Ning <yu.ning@intel.com>
> 
> Anybody (especially non-RH people) disagrees with dual-license CC-BY-SA
> 4.0 and GPLv2+?  (So that we can copy from blog posts to manuals)?

This dual license is exactly what I would have suggested too, as CC-BY-SA
is common place for collaborative web content projects & formal docs
efforts.

Regards,
Daniel
Eric Blake Nov. 28, 2018, 5:15 p.m. UTC | #3 
On 11/28/18 9:35 AM, Daniel P. Berrangé wrote:
> Add a README file that tells people this is a jekyll based static
> website, and shows people how to run jekyll for testing purposes.
> 
> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
> ---
> 
> NB, we should really mention a license in the README too, but I don't
> see info about what license we consider qemu-web to be covered by...
> 
>   README      | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++++
>   _config.yml |  2 ++
>   2 files changed, 55 insertions(+)
>   create mode 100644 README
> 
> diff --git a/README b/README
> new file mode 100644
> index 0000000..d06606a
> --- /dev/null
> +++ b/README
> @@ -0,0 +1,53 @@
> +QEMU Webite
> +===========

s/Webite/Website/ (and the corresponding = line lengthening)


> +* Install Jekyll and its dependencies
> +
> +   # bundle install --path vendor
> +

$ pwd
/home/eblake
$ bundle install --path vendor
Could not locate Gemfile

What am I missing?

> +Jekyll is now installed into the 'vendor/' directory of the git checkout.

Oh - this step must be run within the top-level directory of the 
qemu-web.git checkout (which might be obvious for someone reading the 
README from a fresh qemu-web git checkout, but wasn't for me while 
reviewing the patch).  So I repeated the command in the right directory, 
and it appears to work:

$ bundle install --path vendor
Fetching gem metadata from https://rubygems.org/..............
Fetching gem metadata from https://rubygems.org/..
Resolving dependencies...
Fetching public_suffix 2.0.5
...
Installing jekyll 3.3.0
...
Bundle complete! 9 Gemfile dependencies, 25 gems now installed.
Bundled gems are installed into `./vendor`
...

but I don't know if it is the same version of Jekyll that the 
documentation wanted ("QEMU requires a specific version of Jekyll which 
may not match that provided by your OS vendor" doesn't actually say 
WHICH specific version).

> +Note the 'vendor/' path has been explicitly excluded from the web content
> +in _config.yml, so don't try to use a different path within the git
> +checkout.
> +
> +
> +To test the site launch jeykll
> +
> +  # bundle exec jekyll serve

$ bundle exec jekyll serve
Configuration file: /home/eblake/qemu-web/_config.yml
Configuration file: /home/eblake/qemu-web/_config.yml
             Source: /home/eblake/qemu-web
        Destination: /home/eblake/qemu-web/_site
  Incremental build: disabled. Enable with --incremental
       Generating...
              ERROR: YOUR SITE COULD NOT BE BUILT:
                     ------------------------------------
                     Invalid date '<%= Time.now.strftime('%Y-%m-%d 
%H:%M:%S %z') %>': Document 
'vendor/ruby/2.5.0/gems/jekyll-3.3.0/lib/site_template/_posts/0000-00-00-welcome-to-jekyll.markdown.erb' 
does not have a valid date in the YAML front matter.

Did I do things right?

> +
> +Now simply point a local web browser to http://127.0.0.1:4000 to browse
> +the generated site.
> +
> +Jekyll will usually automatically detect changes to files in the git
> +checkout and regenerate the site. It is thus not normally neccessary

s/neccessary/necessary/

> +to restart jekyll after changing content, unless it shows signs of being
> +confused / stale.
> diff --git a/_config.yml b/_config.yml
> index 0a0201c..576b0a5 100644
> --- a/_config.yml
> +++ b/_config.yml
> @@ -37,3 +37,5 @@ gems:
>   exclude:
>     - Gemfile
>     - Gemfile.lock
> +  - vendor/
> +  - README
>
Eric Blake Nov. 28, 2018, 5:16 p.m. UTC | #4 
On 11/28/18 10:44 AM, Paolo Bonzini wrote:
> On 28/11/18 16:35, Daniel P. Berrangé wrote:
>> Add a README file that tells people this is a jekyll based static
>> website, and shows people how to run jekyll for testing purposes.
>>
>> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
>> ---
>>
>> NB, we should really mention a license in the README too, but I don't
>> see info about what license we consider qemu-web to be covered by...
> 
>       3	Eric Blake <eblake@redhat.com>

> 
> Anybody (especially non-RH people) disagrees with dual-license CC-BY-SA
> 4.0 and GPLv2+?  (So that we can copy from blog posts to manuals)?

For the avoidance of doubt, no disagreement with the proposal in regards 
to my edits (even if Red Hat can step in and make a broader statement on 
my behalf).
Daniel P. Berrangé Nov. 28, 2018, 5:20 p.m. UTC | #5 
On Wed, Nov 28, 2018 at 11:15:11AM -0600, Eric Blake wrote:
> On 11/28/18 9:35 AM, Daniel P. Berrangé wrote:
> > Add a README file that tells people this is a jekyll based static
> > website, and shows people how to run jekyll for testing purposes.
> > 
> > Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
> > ---
> > 
> > NB, we should really mention a license in the README too, but I don't
> > see info about what license we consider qemu-web to be covered by...
> > 
> >   README      | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++++
> >   _config.yml |  2 ++
> >   2 files changed, 55 insertions(+)
> >   create mode 100644 README
> > 
> > diff --git a/README b/README
> > new file mode 100644
> > index 0000000..d06606a
> > --- /dev/null
> > +++ b/README
> > @@ -0,0 +1,53 @@
> > +QEMU Webite
> > +===========
> 
> s/Webite/Website/ (and the corresponding = line lengthening)
> 
> 
> > +* Install Jekyll and its dependencies
> > +
> > +   # bundle install --path vendor
> > +
> 
> $ pwd
> /home/eblake
> $ bundle install --path vendor
> Could not locate Gemfile
> 
> What am I missing?
> 
> > +Jekyll is now installed into the 'vendor/' directory of the git checkout.
> 
> Oh - this step must be run within the top-level directory of the
> qemu-web.git checkout (which might be obvious for someone reading the README
> from a fresh qemu-web git checkout, but wasn't for me while reviewing the
> patch).  So I repeated the command in the right directory, and it appears to
> work:
> 
> $ bundle install --path vendor
> Fetching gem metadata from https://rubygems.org/..............
> Fetching gem metadata from https://rubygems.org/..
> Resolving dependencies...
> Fetching public_suffix 2.0.5
> ...
> Installing jekyll 3.3.0
> ...
> Bundle complete! 9 Gemfile dependencies, 25 gems now installed.
> Bundled gems are installed into `./vendor`
> ...
> 
> but I don't know if it is the same version of Jekyll that the documentation
> wanted ("QEMU requires a specific version of Jekyll which may not match that
> provided by your OS vendor" doesn't actually say WHICH specific version).

Yes,  'bundle install' reads the versions from Gemfile, so it should
get the right version that qemu-web wants. Thus I preferred not to
duplicate the version in the docs too.

> 
> > +Note the 'vendor/' path has been explicitly excluded from the web content
> > +in _config.yml, so don't try to use a different path within the git
> > +checkout.
> > +
> > +
> > +To test the site launch jeykll
> > +
> > +  # bundle exec jekyll serve
> 
> $ bundle exec jekyll serve
> Configuration file: /home/eblake/qemu-web/_config.yml
> Configuration file: /home/eblake/qemu-web/_config.yml
>             Source: /home/eblake/qemu-web
>        Destination: /home/eblake/qemu-web/_site
>  Incremental build: disabled. Enable with --incremental
>       Generating...
>              ERROR: YOUR SITE COULD NOT BE BUILT:
>                     ------------------------------------
>                     Invalid date '<%= Time.now.strftime('%Y-%m-%d %H:%M:%S
> %z') %>': Document 'vendor/ruby/2.5.0/gems/jekyll-3.3.0/lib/site_template/_posts/0000-00-00-welcome-to-jekyll.markdown.erb'
> does not have a valid date in the YAML front matter.
> 
> Did I do things right?

Yes, but this error is what the addition in _config.yml.....

> > diff --git a/_config.yml b/_config.yml
> > index 0a0201c..576b0a5 100644
> > --- a/_config.yml
> > +++ b/_config.yml
> > @@ -37,3 +37,5 @@ gems:
> >   exclude:
> >     - Gemfile
> >     - Gemfile.lock
> > +  - vendor/
> > +  - README

...here is supposed to fix, so I'm puzzelled why you'd still get that
error message

Regards,
Daniel
Eric Blake Nov. 28, 2018, 5:23 p.m. UTC | #6 
On 11/28/18 11:20 AM, Daniel P. Berrangé wrote:
>>> +Note the 'vendor/' path has been explicitly excluded from the web content
>>> +in _config.yml, so don't try to use a different path within the git
>>> +checkout.
>>> +
>>> +
>>> +To test the site launch jeykll
>>> +
>>> +  # bundle exec jekyll serve
>>
>> $ bundle exec jekyll serve
>> Configuration file: /home/eblake/qemu-web/_config.yml
>> Configuration file: /home/eblake/qemu-web/_config.yml
>>              Source: /home/eblake/qemu-web
>>         Destination: /home/eblake/qemu-web/_site
>>   Incremental build: disabled. Enable with --incremental
>>        Generating...
>>               ERROR: YOUR SITE COULD NOT BE BUILT:
>>                      ------------------------------------
>>                      Invalid date '<%= Time.now.strftime('%Y-%m-%d %H:%M:%S
>> %z') %>': Document 'vendor/ruby/2.5.0/gems/jekyll-3.3.0/lib/site_template/_posts/0000-00-00-welcome-to-jekyll.markdown.erb'
>> does not have a valid date in the YAML front matter.
>>
>> Did I do things right?
> 
> Yes, but this error is what the addition in _config.yml.....

Ah, my fault for not actually applying the patch before trying the 
commands.  With the patched _config.yml,...

> 
>>> diff --git a/_config.yml b/_config.yml
>>> index 0a0201c..576b0a5 100644
>>> --- a/_config.yml
>>> +++ b/_config.yml
>>> @@ -37,3 +37,5 @@ gems:
>>>    exclude:
>>>      - Gemfile
>>>      - Gemfile.lock
>>> +  - vendor/
>>> +  - README
> 
> ...here is supposed to fix, so I'm puzzelled why you'd still get that
> error message

...I have a live local server.

Tested-by: Eric Blake <eblake@redhat.com>
Eric Blake Nov. 28, 2018, 5:27 p.m. UTC | #7 
On 11/28/18 11:23 AM, Eric Blake wrote:

> 
> ...I have a live local server.
> 
> Tested-by: Eric Blake <eblake@redhat.com>

I'd also update .gitignore to exclude .bundle/ and vendor/, since those 
now show up as untracked after my testing.
Alex Bennée Nov. 28, 2018, 5:50 p.m. UTC | #8 
Fine with me.

Acked-by: Alex Bennée <alex.bennee@linaro.org>

On Wed, 28 Nov 2018, 16:44 Paolo Bonzini <pbonzini@redhat.com wrote:

> On 28/11/18 16:35, Daniel P. Berrangé wrote:
> > Add a README file that tells people this is a jekyll based static
> > website, and shows people how to run jekyll for testing purposes.
> >
> > Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
> > ---
> >
> > NB, we should really mention a license in the README too, but I don't
> > see info about what license we consider qemu-web to be covered by...
>
>     47  Paolo Bonzini <pbonzini@redhat.com>
>     44  Michael Roth <mdroth@linux.vnet.ibm.com>
>     13  Thomas Huth <thuth@redhat.com>
>      3  Eric Blake <eblake@redhat.com>
>      2  Daniel P. Berrange <berrange@redhat.com>
>      2  Jeff Cody <jcody@redhat.com>
>      1  Alex Bennée <alex.bennee@linaro.org>
>      1  Daniel P. Berrangé <berrange@redhat.com>
>      1  Fam Zheng <famz@redhat.com>
>      1  Rainer Müller <raimue@macports.org>
>      1  Stefan Hajnoczi <stefanha@gmail.com>
>      1  Yu Ning <yu.ning@intel.com>
>
> Anybody (especially non-RH people) disagrees with dual-license CC-BY-SA
> 4.0 and GPLv2+?  (So that we can copy from blog posts to manuals)?
>
> Paolo
>
Thomas Huth Nov. 28, 2018, 6:36 p.m. UTC | #9 
On 2018-11-28 17:44, Paolo Bonzini wrote:
> On 28/11/18 16:35, Daniel P. Berrangé wrote:
>> Add a README file that tells people this is a jekyll based static
>> website, and shows people how to run jekyll for testing purposes.
>>
>> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
>> ---
>>
>> NB, we should really mention a license in the README too, but I don't
>> see info about what license we consider qemu-web to be covered by...
> 
>     47	Paolo Bonzini <pbonzini@redhat.com>
>     44	Michael Roth <mdroth@linux.vnet.ibm.com>
>     13	Thomas Huth <thuth@redhat.com>
>      3	Eric Blake <eblake@redhat.com>
>      2	Daniel P. Berrange <berrange@redhat.com>
>      2	Jeff Cody <jcody@redhat.com>
>      1	Alex Bennée <alex.bennee@linaro.org>
>      1	Daniel P. Berrangé <berrange@redhat.com>
>      1	Fam Zheng <famz@redhat.com>
>      1	Rainer Müller <raimue@macports.org>
>      1	Stefan Hajnoczi <stefanha@gmail.com>
>      1	Yu Ning <yu.ning@intel.com>
> 
> Anybody (especially non-RH people) disagrees with dual-license CC-BY-SA
> 4.0 and GPLv2+?  (So that we can copy from blog posts to manuals)?

FWIW, dual-license is fine for me.

 Thomas
Rainer Müller Nov. 28, 2018, 9:04 p.m. UTC | #10 
On 28.11.18 17:44, Paolo Bonzini wrote:
> On 28/11/18 16:35, Daniel P. Berrangé wrote:
>> Add a README file that tells people this is a jekyll based static
>> website, and shows people how to run jekyll for testing purposes.
>>
>> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
>> ---
>>
>> NB, we should really mention a license in the README too, but I don't
>> see info about what license we consider qemu-web to be covered by...

>      1	Rainer Müller <raimue@macports.org>

> Anybody (especially non-RH people) disagrees with dual-license CC-BY-SA
> 4.0 and GPLv2+?  (So that we can copy from blog posts to manuals)?

No objections from my side.

Rainer
Ning, Yu Nov. 29, 2018, 2:19 a.m. UTC | #11 
> -----Original Message-----
> From: Paolo Bonzini [mailto:pbonzini@redhat.com]
> Sent: Thursday, November 29, 2018 0:44
> To: Daniel P. Berrangé <berrange@redhat.com>; qemu-devel@nongnu.org
> Cc: Thomas Huth <thuth@redhat.com>; raimue@macports.org;
> alex.bennee@linaro.org; Ning, Yu <yu.ning@intel.com>; Eric Blake
> <eblake@redhat.com>; Stefan Hajnoczi <stefanha@redhat.com>
> Subject: Re: [qemu-web PATCH] Document how to test the site with jekyll
> locally
> 
> [...]
> 
> Anybody (especially non-RH people) disagrees with dual-license CC-BY-SA
> 4.0 and GPLv2+?  (So that we can copy from blog posts to manuals)?

I agree with using this dual license.

Thanks,
Yu
Daniel P. Berrangé Dec. 6, 2018, 4:50 p.m. UTC | #12 
Copying Michael Roth as the only remaining non-Red Hat contributor
we still need approval from

On Wed, Nov 28, 2018 at 05:44:09PM +0100, Paolo Bonzini wrote:
> On 28/11/18 16:35, Daniel P. Berrangé wrote:
> > Add a README file that tells people this is a jekyll based static
> > website, and shows people how to run jekyll for testing purposes.
> > 
> > Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
> > ---
> > 
> > NB, we should really mention a license in the README too, but I don't
> > see info about what license we consider qemu-web to be covered by...
> 
>     47	Paolo Bonzini <pbonzini@redhat.com>
>     44	Michael Roth <mdroth@linux.vnet.ibm.com>
>     13	Thomas Huth <thuth@redhat.com>
>      3	Eric Blake <eblake@redhat.com>
>      2	Daniel P. Berrange <berrange@redhat.com>
>      2	Jeff Cody <jcody@redhat.com>
>      1	Alex Bennée <alex.bennee@linaro.org>
>      1	Daniel P. Berrangé <berrange@redhat.com>
>      1	Fam Zheng <famz@redhat.com>
>      1	Rainer Müller <raimue@macports.org>
>      1	Stefan Hajnoczi <stefanha@gmail.com>
>      1	Yu Ning <yu.ning@intel.com>
> 
> Anybody (especially non-RH people) disagrees with dual-license CC-BY-SA
> 4.0 and GPLv2+?  (So that we can copy from blog posts to manuals)?
> 
> Paolo

Regards,
Daniel
Michael Roth Dec. 6, 2018, 5:15 p.m. UTC | #13 
Quoting Daniel P. Berrangé (2018-12-06 10:50:47)
> Copying Michael Roth as the only remaining non-Red Hat contributor
> we still need approval from

No objections from my end.

> 
> On Wed, Nov 28, 2018 at 05:44:09PM +0100, Paolo Bonzini wrote:
> > On 28/11/18 16:35, Daniel P. Berrangé wrote:
> > > Add a README file that tells people this is a jekyll based static
> > > website, and shows people how to run jekyll for testing purposes.
> > > 
> > > Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
> > > ---
> > > 
> > > NB, we should really mention a license in the README too, but I don't
> > > see info about what license we consider qemu-web to be covered by...
> > 
> >     47        Paolo Bonzini <pbonzini@redhat.com>
> >     44        Michael Roth <mdroth@linux.vnet.ibm.com>
> >     13        Thomas Huth <thuth@redhat.com>
> >      3        Eric Blake <eblake@redhat.com>
> >      2        Daniel P. Berrange <berrange@redhat.com>
> >      2        Jeff Cody <jcody@redhat.com>
> >      1        Alex Bennée <alex.bennee@linaro.org>
> >      1        Daniel P. Berrangé <berrange@redhat.com>
> >      1        Fam Zheng <famz@redhat.com>
> >      1        Rainer Müller <raimue@macports.org>
> >      1        Stefan Hajnoczi <stefanha@gmail.com>
> >      1        Yu Ning <yu.ning@intel.com>
> > 
> > Anybody (especially non-RH people) disagrees with dual-license CC-BY-SA
> > 4.0 and GPLv2+?  (So that we can copy from blog posts to manuals)?
> > 
> > Paolo
> 
> Regards,
> Daniel
> -- 
> |: https://berrange.com      -o-    https://www.flickr.com/photos/dberrange :|
> |: https://libvirt.org         -o-            https://fstop138.berrange.com :|
> |: https://entangle-photo.org    -o-    https://www.instagram.com/dberrange :|
>
diff mbox series

Patch

diff --git a/README b/README
new file mode 100644
index 0000000..d06606a
--- /dev/null
+++ b/README
@@ -0,0 +1,53 @@ 
+QEMU Webite
+===========
+
+This repository provides content for the QEMU website.
+
+It uses the Jekyll site generator for turning the static content into
+a format which can then be directly hosted by a regular HTTP server
+such as Apache.
+
+
+Testing locally with Jekyll
+---------------------------
+
+When adding/changing content on this site, it is possible to run a
+local Jekyll service to test the result.
+
+QEMU requires a specific version of Jekyll which may not match that
+provided by your OS vendor. Thus as a one time step the Jekyll software
+must be installed locally as follows:
+
+* Install OS vendor ruby with development headers
+
+   # sudo dnf install ruby ruby-devel  (Fedora)
+   # sudo yum install ruby ruby-devel  (RHEL)
+   # sudo apt-get install ruby ruby-dev (Debian / Ubuntu)
+
+* Install OS vendor ruby gem bundler
+
+   # sudo dnf install rubygem-bundler  (Fedora)
+   # sudo yum install rubygem-bundler  (RHEL)
+   # sudo apt-get install bundler (Debian / Ubuntu)
+
+* Install Jekyll and its dependencies
+
+   # bundle install --path vendor
+
+Jekyll is now installed into the 'vendor/' directory of the git checkout.
+Note the 'vendor/' path has been explicitly excluded from the web content
+in _config.yml, so don't try to use a different path within the git
+checkout.
+
+
+To test the site launch jeykll
+
+  # bundle exec jekyll serve
+
+Now simply point a local web browser to http://127.0.0.1:4000 to browse
+the generated site.
+
+Jekyll will usually automatically detect changes to files in the git
+checkout and regenerate the site. It is thus not normally neccessary
+to restart jekyll after changing content, unless it shows signs of being
+confused / stale.
diff --git a/_config.yml b/_config.yml
index 0a0201c..576b0a5 100644
--- a/_config.yml
+++ b/_config.yml
@@ -37,3 +37,5 @@  gems:
 exclude:
   - Gemfile
   - Gemfile.lock
+  - vendor/
+  - README