Commit graph

58 commits

Author SHA1 Message Date
Miah Johnson
2a1b1d8e88 Remove all leading newlines.
Signed-off-by: Miah Johnson <miah@chia-pet.org>
2019-05-31 11:43:44 -07:00
Miah Johnson
659b4b373a Remove # encoding: utf8 magic comments
Signed-off-by: Miah Johnson <miah@chia-pet.org>
2019-05-07 16:06:23 -07:00
Clinton Wolfe
780efbea74 Modify resources index to shorten OS Resources button
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-04-11 16:17:04 -04:00
Tim Smith
a1aef8fe17 Update list of SPDX licenses (#3677)
Signed-off-by: Tim Smith <tsmith@chef.io>
2018-12-20 14:41:11 -05:00
Clinton Wolfe
fa0a6c9794 Ability to render contrib resource pack docs on main website (#3184)
* Sketch out contrib doc fetcher
* Read contrib config file
* Fetch contrib resource packs from git
* Copy in resource pack docs from contrib
* Task to cleanup copied-in files
* Attach contrib resource pack docs fetching to main website doc generation
* Refactor - rename vars in resource overview task for clarity
* Generate resource overview page using info from contrib
* Fix issue in which AWS and Azure resources were ending up under OS
* Trigger contrib doc cleanup after doc build
* Comment out the contrib.yaml for now
* Disable contrib tasks if git is not available
* Rubocop issues
* Allow .md as doc file ending
* Fix for files ending in md having a relative link
* Omit 'resources' from section labels to save width
* Rubocoooooooooooppppp

Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2018-08-02 11:43:46 -04:00
Clinton Wolfe
2ac5581d32 Document exit codes for 'inspec exec' and add --no-distinct-exit option (#3178)
* Add long description to inspec exec command, mentioning exit codes
* Modify website doc builder code to use long description if available
* Functional test for --distinct-exit flag
* Implement --distinct-exit option
* Inspec shell also needs the option

Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2018-06-29 08:43:34 -04:00
hannah-radish
959f1e2ee0 HM website optimization (#2699)
* Font awesome

* Scroll to resources - done

* Overwriting swift type styles

* Fixed links

* Remove DL bin

* lint

Signed-off-by: Dominik Richter <dominik.richter@gmail.com>

* lint

Signed-off-by: Dominik Richter <dominik.richter@gmail.com>

* Add new breakpoints
2018-02-19 13:14:01 -08:00
Christoph Hartmann
4641978716 Update InSpec website (#2681)
* New styles

* Fundamental styles for home page

* Legal pages

* Community page, downloads page, tutorials page

* Docs page

* Content toggle and github badge

* Add code - highlighter

* Copy button

* Sliding content animation

* fix particle animatino on downloads page

* Scroll-to-top button

* docs sidebar links

* innocent comments on resources

* Fancy code animation

* Small update to diamond

* whatever slider

* Slider styles

* initial selection if no sliders are there

* add netifly config

Signed-off-by: Christoph Hartmann <chris@lollyrock.com>

* inspec for provisioners

* fix incorrect text on aws ssm

* fix layout javascript

post-rebase

* resource grouping in docs

* introduce groups in docs/resources

* fix minor spelling issues and move download button in new features section

Signed-off-by: Christoph Hartmann <chris@lollyrock.com>

* pass linting

Signed-off-by: Christoph Hartmann <chris@lollyrock.com>
2018-02-17 07:44:42 -08:00
Jared Quick
7dc9ab8445 Fixed italics link names for resources.
Signed-off-by: Jared Quick <jquick@chef.io>
2018-02-15 10:58:16 -05:00
Adam Leff
4b9acb4800 Bump Rubocop to 0.49.1 (#2323)
* Bump Rubocop to 0.49.1

This change bumps Rubocop to 0.49.1. There have been a lot of changes
since 0.39.0 and this PR is hopefully a nice compromise of turning off
certain cops and updating our codebase to take advantage of new Ruby
2.3 methods and operators.

Signed-off-by: Adam Leff <adam@leff.co>

* Set end-of-line format to line-feed only, avoid Windows-related CRLF issues

Signed-off-by: Adam Leff <adam@leff.co>
2017-11-21 08:49:41 +01:00
Adam Leff
e469a947fc Fix sorting of resources on website (#2267)
Not sure how this ever worked without us force-sorting, but the
list of resources is now guaranteed to be alpha-sorted.

Signed-off-by: Adam Leff <adam@leff.co>
2017-10-26 17:02:48 -04:00
Adam Leff
1ee22a7c4e Remove changelog generator stuff (#2048)
Version bumping and changelog generation has been moved to
Chef's expeditor tool. The github_changelog_generator bits
and the Rake tasks that use them are no longer necessary.

Also, the old historical changelog has been merged back into
the main CHANGELOG.md file since Expeditor does not alter
any existing changelog content like github_changelog_generator
does, so it's safe to bring this stuff back.

Signed-off-by: Adam Leff <adam@leff.co>
2017-08-03 22:53:24 +02:00
Adam Leff
a6582bea9b Remove any "All Rights Reserved" references (#1969)
* Remove any "All Rights Reserved" references

InSpec is licensed and released under the Apache 2.0 license. This
change removes all reference to legacy code files that still had
any Copyright or License lines referring to "All Rights Reserved".

Signed-off-by: Adam Leff <adam@leff.co>

* fix functional tests

Signed-off-by: Christoph Hartmann <chris@lollyrock.com>
2017-06-28 04:14:19 -07:00
Adam Leff
c808712182 Exclude 2.0 Release PRs from current changelog (#1953)
PRs that get merged to the 'release-2.0' branch will
have this label applied which we want to ensure do
not get included in the existing CHANGELOG.md

Signed-off-by: Adam Leff <adam@leff.co>
2017-06-23 07:43:32 -07:00
pete higgins
89e30f8d31 Reduce warnings (#1917)
* Remove some apparently unused test setup to remove some warnings.
* Initialize some instance variables before use to silence warnings.
* Remove an unused variable to remove a warning.
* Remove some indirection.
* Silence logger during tests.
* Check if an instance variable was defined before referencing to remove a warning.
* Define duplicated constant once in root rakefile.
* Initialize an instance variable to remove a warning.
* Remove PROJECT_DIR to reduce coupling.

Signed-off-by: Pete Higgins <pete@peterhiggins.org>
2017-06-15 12:10:47 -04:00
Christoph Hartmann
a6ef98c896 verifies that inspec.yml uses licenses in SPDX format
Signed-off-by: Christoph Hartmann <chris@lollyrock.com>
2017-05-31 00:21:05 -05:00
Adam Leff
24e2ffb7e0 Allow docs Rake task to be run from outside www dir
The docs Rake task requires classes defined in the "shared"
Rake tasks file. However, only the www Rakefile includes the
"shared" tasks file.

Since the "docs" Rake task is what needs it, I'm adding a require
there to ensure it works from outside the www directory.

Signed-off-by: Adam Leff <adam@leff.co>
2017-05-29 16:00:19 -04:00
Adam Leff
6c006f5425
Fix version string in changelog generator
When I made the change to pull the version from ENV (as is used
during the bump_version rake task), I neglected to prefix it with
a "v", which causes the "full changelog" links to be incorrect.

Signed-off-by: Adam Leff <adam@leff.co>
2017-05-11 15:15:00 -04:00
Adam Leff
02a023b2ff Update changelog generator to work from PRs only
To clean up our Changelog, this change modifies the use of
github-changelog-generator to only use PRs. This ensures
that our Changelog only reflects actual changes and makes
it easier for our users to see the actual changes made to
the codebase.

docs and www changes will be excluded from the Changelog as well.

The CHANGELOG.md will start from v1.21.0. All release prior to
v1.21.0 have been moved to HISTORICAL_CHANGELOG.md which will
remain static. Should we be able to bend github-changelog-generator
to our ways, I'll merge them back together at a future date.

Signed-off-by: Adam Leff <adam@leff.co>
2017-05-09 12:41:27 +02:00
Adam Leff
65c95d243e Fixing www/docs rake tasks
This is a follow-up to #1585. The website-related Rake tasks have been
moved to a www-specific Rakefile which can be found in the www/
directory. Any web-release-related gems have been moved to the www
Gemfile as well.

This also included modifying the docs rake tasks to be path-
independent as they currently expect that Rake is being run from the
root of the repo.

Signed-off-by: Adam Leff <adam@leff.co>
2017-03-22 12:21:03 -04:00
Dominik Richter
45e3016acb create inspec.io/tutorial.html
Signed-off-by: Dominik Richter <dominik.richter@gmail.com>
2017-02-14 04:18:16 +01:00
Tom Duffield
1ea83f526c Address rubocop violations
Signed-off-by: Tom Duffield <tom@chef.io>
2017-02-08 16:49:16 -06:00
Dominik Richter
995c42f9bb dont remove gh-pages if it doesnt exist 2016-12-02 13:06:46 +01:00
Nathen Harvey
7e4157ddf4 Headers and list elements that include more than one _ character were being rendered incorrectly. (Perhaps it is only when there are an even number but in any case I only found words with either one or two _s.)
The html rendered from markdown would look like:

`<h3>be<em>grouped</em>into</h3>`

When there is only one `_` the html rendered correctly:

`<h3>be_directory</h3>`

This change escapes the `_` when there are multiple.

* New markdown:  `### be\_grouped\_into`
* New html:      `<h3>be_grouped_into</h3>`

resource matchers fixed:
* be_block_device
* be_character_device
* be_grouped_into
* be_linked_to
* be_owned_by
* have_app_pool
* have_property_value

resource fixed:
* parse_config_file

Signed-off-by: Nathen Harvey <nharvey@chef.io>
2016-10-20 07:07:18 -04:00
Victoria Jeffrey
12b69280b1 add sanity checks for docs and middleman build 2016-09-28 12:10:54 -04:00
Dominik Richter
9a816b2b7d add verifiers for tutorial build step
https://github.com/chef/inspec/issues/1182
2016-09-28 16:52:08 +02:00
Dominik Richter
695680a581 www: stop build process if any shell commands fail
use `sh` instead of `system`; `sh` fails, system just returns `nil` and saves the status...
2016-09-28 16:40:15 +02:00
Victoria Jeffrey
4baf1ae99c move inquirer to deploy 2016-09-27 14:23:32 -04:00
Dominik Richter
0e7ca5cc3d build docs for www/ 2016-09-26 07:03:37 +02:00
Dominik Richter
d74b07a5f5 clean www before releasing 2016-09-26 06:35:20 +02:00
Dominik Richter
af92ae559f rake to render all docs to www/ correctly with links 2016-09-26 06:21:05 +02:00
Dominik Richter
959509fd70 embed tutorial inside the website 2016-09-23 16:01:18 +02:00
Dominik Richter
2e3d287f7d bugfix: build all online tutorial assets 2016-09-23 15:31:18 +02:00
Dominik Richter
c7d9563432 add build tasks for www/tutorial 2016-09-23 15:27:34 +02:00
Dominik Richter
d842771b68 add build tasks for www 2016-09-22 23:51:30 +02:00
Dominik Richter
45d56439c5 add resources.md doc generation 2016-09-22 17:54:20 +02:00
Dominik Richter
f9248033c3 render resource docs 2016-09-22 16:47:58 +02:00
Dominik Richter
f179c88074 improve cli docs styling 2016-09-22 13:49:56 +02:00
Dominik Richter
a4982fc4f1 generate docs for cli 2016-09-22 13:43:57 +02:00
Dominik Richter
31da5881ec add metadata to markdown 2016-09-20 13:58:20 +02:00
Dominik Richter
59673f5069 added markdown to docs generation 2016-09-20 13:33:24 +02:00
Dominik Richter
305ca04f65 separate docs RST formatter 2016-09-20 13:18:20 +02:00
Christoph Hartmann
f54fa7bbdf optimize command simulator auto-generation 2016-09-16 14:27:16 +02:00
Victoria Jeffrey
645f997ac1 format instructions, css fixes, fix scrolling 2016-09-13 18:38:04 -04:00
Victoria Jeffrey
66e54b675f load content into demo and handle shell commands 2016-09-12 09:39:16 +02:00
Victoria Jeffrey
58cf016410 add ability to up-arrow thru commands, a couple css fixes 2016-09-01 22:33:41 +01:00
Victoria Jeffrey
1ea965080a initial commit 2016-09-01 22:33:41 +01:00
Victoria Jeffrey
83dfe494e7 move train connection out of loop for command_simulator 2016-08-25 12:53:42 -04:00
Christoph Hartmann
e91b885b03 Merge pull request #977 from chef/vj/get-command-output
first pass at collecting command output for demo
2016-08-25 18:07:38 +02:00
Victoria Jeffrey
2982fba946 switch to using train 2016-08-25 11:31:40 -04:00