CONJ-4525 Remove docs from conjur repo (#502)

* WIP - Remove docs from conjur repo * Adding new README docs * Tweaking apidocs/README.md Tweaking verbiage and display of /apidocs/README.md * Wording tweak * Wording tweak
cyberark · Dec 13, 2017 · ec556c8 · ec556c8
1 parent 764ff87
commit ec556c8
Show file tree

Hide file tree

Showing 224 changed files with 29 additions and 15,347 deletions.
diff --git a/.gitignore b/.gitignore
@@ -22,7 +22,6 @@ config/database.yml
 reports
 demo/run/finished
 demo/run/load
-_site
 /run
 coverage
 .DS_Store
@@ -31,20 +30,9 @@ demo/run/*.yml
 apidocs/node_modules
 docs/apidocs.html
 *.config
-docs/_layouts/page-toc.html
-
-# NGINX tutorial temp files
-/docs/tutorials/nginx/tls/nginx.crt
-/docs/tutorials/nginx/tls/nginx.key
-/docs/tutorials/nginx/test.out
 
 # Generated API docs
 api.html
 
-# Generated js bundles
-/public/javascripts/*
-/public/stylesheets/*
-/public/assets/*
-
 # Emacs backup files
 *~
diff --git a/Dockerfile.docs b/Dockerfile.docs
diff --git a/Gemfile b/Gemfile
@@ -68,13 +68,3 @@ group :development, :test do
   gem 'rails_layout'
   gem 'rspec-core', '~> 3.0'
 end
-
-group :website do
-  gem 'jekyll', group: :jekyll_plugins
-  gem 'jekyll-coffeescript'
-  gem 'jekyll-paginate'
-  gem 'jekyll-redirect-from'
-  gem 'jekyll-sitemap'
-  gem 'rack-jekyll'
-  gem 'html-proofer'
-end
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -52,8 +52,6 @@ GEM
       minitest (~> 5.1)
       thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
-    addressable (2.5.1)
-      public_suffix (~> 2.0, >= 2.0.2)
     arel (6.0.4)
     aruba (0.14.2)
       childprocess (~> 0.5.6)
@@ -78,12 +76,6 @@ GEM
       ci_reporter (~> 2.0)
       rspec (>= 2.14, < 4)
     coderay (1.1.1)
-    coffee-script (2.4.1)
-      coffee-script-source
-      execjs
-    coffee-script-source (1.12.2)
-    colorator (1.1.0)
-    colored (1.2)
     concurrent-ruby (1.0.5)
     conjur-cli (6.0.0)
       activesupport
@@ -126,68 +118,31 @@ GEM
     domain_name (0.5.20170404)
       unf (>= 0.0.5, < 1.0.0)
     erubis (2.7.0)
-    ethon (0.10.1)
-      ffi (>= 1.3.0)
     excon (0.55.0)
     execjs (2.7.0)
     ffi (1.9.18)
     font-awesome-sass (4.7.0)
       sass (>= 3.2)
-    forwardable-extended (2.6.0)
     gherkin (4.1.1)
     gli (2.16.1)
     globalid (0.4.0)
       activesupport (>= 4.2.0)
     highline (1.7.8)
-    html-proofer (3.7.2)
-      activesupport (>= 4.2, < 6.0)
-      addressable (~> 2.3)
-      colored (~> 1.2)
-      mercenary (~> 0.3.2)
-      nokogiri (~> 1.7)
-      parallel (~> 1.3)
-      typhoeus (~> 0.7)
-      yell (~> 2.0)
     http-cookie (1.0.3)
       domain_name (~> 0.5)
     i18n (0.8.6)
-    jekyll (3.4.3)
-      addressable (~> 2.4)
-      colorator (~> 1.0)
-      jekyll-sass-converter (~> 1.0)
-      jekyll-watch (~> 1.1)
-      kramdown (~> 1.3)
-      liquid (~> 3.0)
-      mercenary (~> 0.3.3)
-      pathutil (~> 0.9)
-      rouge (~> 1.7)
-      safe_yaml (~> 1.0)
-    jekyll-coffeescript (1.0.1)
-      coffee-script (~> 2.2)
-    jekyll-paginate (1.1.0)
-    jekyll-redirect-from (0.12.1)
-      jekyll (~> 3.3)
-    jekyll-sass-converter (1.5.0)
-      sass (~> 3.4)
-    jekyll-sitemap (1.1.1)
-      jekyll (~> 3.3)
-    jekyll-watch (1.5.0)
-      listen (~> 3.0, < 3.1)
     json (2.1.0)
     json_spec (1.1.5)
       multi_json (~> 1.0)
       rspec (>= 2.0, < 4.0)
-    kramdown (1.13.2)
     libv8 (3.16.14.19)
-    liquid (3.0.6)
     listen (3.0.6)
       rb-fsevent (>= 0.9.3)
       rb-inotify (>= 0.9.7)
     loofah (2.0.3)
       nokogiri (>= 1.5.9)
     mail (2.6.5)
       mime-types (>= 1.16, < 4)
-    mercenary (0.3.6)
     method_source (0.8.2)
     mime-types (3.1)
       mime-types-data (~> 3.2015)
@@ -200,8 +155,6 @@ GEM
     nokogiri (1.8.1)
       mini_portile2 (~> 2.3.0)
     parallel (1.11.1)
-    pathutil (0.14.0)
-      forwardable-extended (~> 2.6)
     pg (0.20.0)
     pry (0.10.4)
       coderay (~> 1.1.0)
@@ -210,13 +163,8 @@ GEM
     pry-byebug (3.4.2)
       byebug (~> 9.0)
       pry (~> 0.10)
-    public_suffix (2.0.5)
     puma (3.8.2)
     rack (1.6.8)
-    rack-jekyll (0.5.0)
-      jekyll (>= 1.3)
-      listen (>= 1.3)
-      rack (~> 1.5)
     rack-rewrite (1.5.1)
     rack-test (0.6.3)
       rack (>= 1.0)
@@ -264,7 +212,6 @@ GEM
       http-cookie (>= 1.0.2, < 2.0)
       mime-types (>= 1.16, < 4.0)
       netrc (~> 0.8)
-    rouge (1.11.1)
     rspec (3.5.0)
       rspec-core (~> 3.5.0)
       rspec-expectations (~> 3.5.0)
@@ -330,8 +277,6 @@ GEM
     thor (0.19.4)
     thread_safe (0.3.6)
     tilt (2.0.8)
-    typhoeus (0.8.0)
-      ethon (>= 0.8.0)
     tzinfo (1.2.3)
       thread_safe (~> 0.1)
     uglifier (3.2.0)
@@ -340,7 +285,6 @@ GEM
       unf_ext
     unf_ext (0.0.7.4)
     xdg (2.2.3)
-    yell (2.0.7)
 
 PLATFORMS
   ruby
@@ -363,20 +307,13 @@ DEPENDENCIES
   database_cleaner
   font-awesome-sass (~> 4.7.0)
   gli
-  html-proofer
-  jekyll
-  jekyll-coffeescript
-  jekyll-paginate
-  jekyll-redirect-from
-  jekyll-sitemap
   json_spec
   listen
   nokogiri (>= 1.8.1)
   parallel
   pg
   pry-byebug
   puma
-  rack-jekyll
   rack-rewrite
   rails (~> 4.2)
   rails-api

diff --git a/Jenkinsfile b/Jenkinsfile
@@ -52,21 +52,6 @@ pipeline {
       }
     }
 
-    stage('Check website for broken links') {
-      steps {
-        sh './checklinks.sh'
-      }
-    }
-
-    stage('Publish website - Prod') {
-      when {
-        branch 'master'
-      }
-      steps {
-        sh 'summon ./website.sh'
-      }
-    }
-
     stage('Publish Conjur to Heroku') {
       when {
         branch 'master'

diff --git a/README.md b/README.md
@@ -186,23 +186,6 @@ root@9feae5e5e001:/src/conjur/cucumber/api# cucumber
 root@9feae5e5e001:/src/conjur# cucumber -r cucumber/api/features/support -r cucumber/api/features/step_definitions cucumber/api/features/resource_list.feature
 ```
 
-## Documentation site
-
-This repository also contains the entire source code for the [Conjur
-documentation website][docs]. For instructions on how to work on the
-site locally, visit the [docs README][docs-readme].
-
-Or in brief:
-
-```sh-session
-$ docker-compose run --rm apidocs > docs/_includes/api.html
-$ docker-compose up -d docs
-$ open localhost:4000
-```
-
-[docs]: https://www.conjur.org "Conjur website"
-[docs-readme]: docs/README.md "Conjur docs README"
-
 # Architecture
 
 Conjur is designed to run in a Docker container(s), using Postgresql as the

diff --git a/apidocs/README.md b/apidocs/README.md
@@ -0,0 +1,26 @@
+# API Documentation
+
+The purpose of this sub-project/folder is to generate an html file
+to be consumed by the documentation site. If you want to view the
+file generated for this, perform this step:
+
+```sh-session
+$ cd "$(git rev-parse --show-toplevel)" # cd to project root
+$ docker-compose run --rm apidocs > api.html
+```
+
+This will generate the HTML partial into the project root.
+
+## Working on the API docs
+
+If you're working on the API docs locally, you can get a live-updating
+dev server:
+
+```sh-session
+$ cd $(git rev-parse --show-cdup) # start in the project root
+$ docker-compose run --rm --service-ports apidocs -w
+```
+
+Then navigate to `localhost:3000` to see the API docs in your browser.
+
+To stop the container, hit <kbd>Ctrl-c</kbd>.
diff --git a/checklinks.sh b/checklinks.sh
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -1,14 +1,5 @@
 version: '2'
 services:
-  docs:
-    build:
-      context: .
-      dockerfile: Dockerfile.docs
-    image: conjur-docs
-    ports:
-      - 4000:4000
-    volumes:
-      - .:/usr/src
   apidocs:
     build:
       context: ./apidocs

diff --git a/docs/.project b/docs/.project