Commit graph

32 commits

Author SHA1 Message Date
Sonu Saha
724b5c5f60 REFACTOR: Remove repetitive dl closing for subcommands of single command
Signed-off-by: Sonu Saha <sonu.saha@progress.com>
2023-02-02 12:45:25 +05:30
Sonu Saha
5d9e023828 FORMAT: Use html dl, dt, dd tags for displaying subcommands
Signed-off-by: Sonu Saha <sonu.saha@progress.com>
2023-02-01 16:32:00 +05:30
Sonu Saha
e70d8091d6 Remove unused require
Signed-off-by: Sonu Saha <sonu.saha@progress.com>
2023-02-01 10:39:19 +05:30
Sonu Saha
9137afd84c RAKE TEST: Fix rake task for docs:cli
Signed-off-by: Sonu Saha <sonu.saha@progress.com>
2023-01-31 21:31:06 +05:30
Sonu Saha
ae90a28838
CFINSPEC-522: Remove rake tasks which are no longer used (#6367)
* CLEAN-UP: Remove unused rake tasks
missing, kitchen and version tasks are not used

Signed-off-by: Sonu Saha <sonu.saha@progress.com>

* CLEAN-UP: Remove functional rake test
test:default covers both unit and functional tests
default was introduced to cover both functional and unit in PR #4102

Signed-off-by: Sonu Saha <sonu.saha@progress.com>

* CLEAN-UP: Remove unused docs related tasks

Signed-off-by: Sonu Saha <sonu.saha@progress.com>

* CLEAN-UP: Remove tasks/* from expeditor config

Signed-off-by: Sonu Saha <sonu.saha@progress.com>

* REVERT: Undo deletion of functional test

Signed-off-by: Sonu Saha <sonu.saha@progress.com>

* RECOVER: Retain docs:cli task

Signed-off-by: Sonu Saha <sonu.saha@progress.com>

* UNDO: Revert changes to config

Signed-off-by: Sonu Saha <sonu.saha@progress.com>

* CHORE: Add reference to this PR in note for future use

Signed-off-by: Sonu Saha <sonu.saha@progress.com>

---------

Signed-off-by: Sonu Saha <sonu.saha@progress.com>
2023-01-31 10:07:38 -05:00
Ryan Davis
c8fb6c9d6f Another chefstyle snafu.
Signed-off-by: Ryan Davis <zenspider@chef.io>
2019-11-08 16:24:14 -08:00
Ryan Davis
1750139dbb Revamp www rakefile and friends to make pushing doco easier.
Signed-off-by: Ryan Davis <zenspider@chef.io>
2019-11-06 18:26:14 -08:00
Miah Johnson
a4f4fe5231 chefstyle -a; https://github.com/chef/chefstyle/pull/74
Signed-off-by: Miah Johnson <miah@chia-pet.org>
2019-07-08 17:22:50 -07:00
Ryan Davis
a5309ea392 blindly applied chefstyle -a
Signed-off-by: Ryan Davis <zenspider@chef.io>
2019-06-11 18:52:03 -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
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
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
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
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
Tom Duffield
1ea83f526c Address rubocop violations
Signed-off-by: Tom Duffield <tom@chef.io>
2017-02-08 16:49:16 -06: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
af92ae559f rake to render all docs to www/ correctly with links 2016-09-26 06:21:05 +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