Fix Authentication Issues #10

jputrino · 2015-10-22T21:50:32Z

@F5Networks/openstack-dev

pushed commits that should fix #9 & #5; need travis to run on this repo to see if it actually works.

- added a travis variable to the build script in the commit message that should prevent a new build on 'site' branch from kicking off a new build. - defined pygments as the jekyll highlighting tool

- started explaining the build and deployment process in the README for the f5-openstack-docs repo - made a minor edit to an 'echo' command in the build script

- entered encrypted env variables for github username and password in the build script so travis can build from the F5Networks repo.

What I changed: - I added an encrypted env variable for the AWS Access key for travis-ci

jlongstaf · 2015-10-22T21:56:16Z

I'll merge your request.

Jeff

From: Jodie Putrino <notifications@github.com mailto:notifications@github.com>
Reply-To: F5Networks/f5-openstack-docs <reply@reply.github.com mailto:reply@reply.github.com>
Date: Thursday, October 22, 2015 at 3:50 PM
To: F5Networks/f5-openstack-docs <f5-openstack-docs@noreply.github.com mailto:f5-openstack-docs@noreply.github.com>
Cc: Jeff Longstaff <j.longstaff@f5.com mailto:j.longstaff@f5.com>
Subject: [f5-openstack-docs] Fix Authentication Issues (#10)

@F5Networks/openstack-devhttps://github.com/orgs/F5Networks/teams/openstack-dev

pushed commits that should fix #9 #9 & #5 #5; need travis to run on this repo to see if it actually works.

You can view, comment on, or merge this pull request online at:

#10

Commit Summary

What I changed:
What I changed:
What I changed:
Fixes Issue travis deployment to s3 is failing #5 - Travis deployment to s3 is failing

File Changes

M .travis.ymlhttps://github.com/Fix Authentication Issues #10/files#diff-0 (4)
M README.mdhttps://github.com/Fix Authentication Issues #10/files#diff-1 (38)
M _config.ymlhttps://github.com/Fix Authentication Issues #10/files#diff-2 (1)
M script/cibuild.shhttps://github.com/Fix Authentication Issues #10/files#diff-3 (6)

Patch Links:

Reply to this email directly or view it on GitHubhttps://github.com//pull/10.

Fix Authentication Issues

Fixes Issue #10 - Travis authentication issues

Merge develop into master

Problem: I accidentally removed the README a while back. Analysis: Unit/Robot tests: Update .travis.yml What I changed: - I replaced the hard-coded repo name with the travis_repo_slug variable. - I replaced the hard-coded branch name with the travis_branch variable. Update .travis.yml I forgot to use $ in the variable names in the last commit. Update cibuild.sh What I changed: - I removed the jekyll and htmlproof executables from the script (moving them to the .travis.yml file). - I added the content of ci_pre-deploy.sh here (will be deleting ci_pre-deploy bc travis will only run one script and I prefer to use this one). Delete ci_deploy.sh Delete ci_pre-deploy.sh Update README.md updated URL for travis build icon Update .travis.yml What I changed: - added travis variable for repo name in deploy section - added travis variable for branch in deploy section Update cibuild.sh What I changed: - replaced http clone url with SSH clone url Revert "Update cibuild.sh" This reverts commit e62c190. Revert "Update cibuild.sh" This reverts commit 302b21d. Update .travis.yml What I changed: - Removed GH_TOKEN; replacing with variable GH_USER (which is configured in repos in travis-ci.com) in script. What I changed: - added a travis variable to the build script in the commit message that should prevent a new build on 'site' branch from kicking off a new build. - defined pygments as the jekyll highlighting tool What I changed: - started explaining the build and deployment process in the README for the f5-openstack-docs repo - made a minor edit to an 'echo' command in the build script What I changed: - entered encrypted env variables for github username and password in the build script so travis can build from the F5Networks repo. Fixes Issue #10 - Travis authentication issues Problem: Travis is unable to push content of site_build folder back to github repo bc authentication fails. Solution: Za and Jeff explained that as long as we have the framework for building the site in github, we don't need the actual site there, too. What I changed: - removed the commands from the cibuild.sh script that told travis to clone the repo and push to the site branch - removed the gh token section from .travis.yml - removed the 'blacklist' section from .travis.yml What I changed: added the command to copy the site build dir over to the local dir back in; the deploy section tells travis to deploy to s3 from $HOME/site_build Fixes: Pull request triggers travis build, but doesn't deploy to Amazon S3 Problem: I took out the command that copied the site build over to the home dir in travis. Analysis: I added the command back in in the previous commit; in this one, I corrected a typo that triggered an error. Unit/Robot tests: Fixes: JIRA - OPENSTACK-28: Docs Website Configuration Problem: We need a website to publicly host the OpenStack docs. Analysis: I made a website. - updated bootstrap template with some F5 Cloud Ready text and links - updated the README with some information about the ci build and deployment process Unit/Robot tests: Fixes: Use pandoc for markdown to html conversion. Problem: I need to use pandoc to convert markdown files to html files. Analysis: I added commands to the jekyll _config.yml file that tell it to use pandoc as the markdown converter. Unit/Robot tests:

Update ci_pre-deploy.sh What I changed: I added the travis "$TRAVIS_REPO_SLUG" variable in place of the actual github repo name. Update .travis.yml What I changed: I changed `before_install` to `before_script` because the chmod doesn't need to occur before the dependencies are installed. I then placed the section after the env variables. Update ci_pre-deploy.sh What I changed: - I commented out the if / then statement for now (will test adding that back in once everything is building to my satisfaction) - I added a command to build the site to a new directory (./site_build) Update .travis.yml What I changed: - I replaced the hard-coded repo name with the travis_repo_slug variable. - I replaced the hard-coded branch name with the travis_branch variable. Update .travis.yml I forgot to use $ in the variable names in the last commit. Update cibuild.sh What I changed: - I removed the jekyll and htmlproof executables from the script (moving them to the .travis.yml file). - I added the content of ci_pre-deploy.sh here (will be deleting ci_pre-deploy bc travis will only run one script and I prefer to use this one). Delete ci_deploy.sh Delete ci_pre-deploy.sh Update .travis.yml Update cibuild.sh Added commands to build and proof back in. Update cibuild.sh What I changed: - commented out the html proofer for now, since a lot is broken in the template. Update .travis.yml What I changed: - added local directory 'site_build' as the directory from which to deploy to s3. Update README.md updated URL for travis build icon Update .travis.yml What I changed: - added travis variable for repo name in deploy section - added travis variable for branch in deploy section Fixes: No bug ID Problem: Travis build breaks bc GH_TOKEN isn't valid for the F5Networks repo. Analysis: I made travis its own github account, generated an access token, encrypted it, and added it to the .travis.yml file. Unit/Robot tests: Update cibuild.sh What I changed: -- replaced GH_TOKEN with GH_USER Update cibuild.sh What I changed: - replaced http clone url with SSH clone url Revert "Update cibuild.sh" This reverts commit e62c1908de7f76c265c2a55f6033ff5e0528b5ed. Revert "Update cibuild.sh" This reverts commit 302b21d445e5fe4ceb517a9441974d8f26901dcc. Travis CI and website configurations Update ci_pre-deploy.sh What I changed: I added the travis "$TRAVIS_REPO_SLUG" variable in place of the actual github repo name. Update .travis.yml What I changed: I changed `before_install` to `before_script` because the chmod doesn't need to occur before the dependencies are installed. I then placed the section after the env variables. Update ci_pre-deploy.sh What I changed: - I commented out the if / then statement for now (will test adding that back in once everything is building to my satisfaction) - I added a command to build the site to a new directory (./site_build) Update .travis.yml What I changed: - I replaced the hard-coded repo name with the travis_repo_slug variable. - I replaced the hard-coded branch name with the travis_branch variable. Update .travis.yml I forgot to use $ in the variable names in the last commit. Update cibuild.sh What I changed: - I removed the jekyll and htmlproof executables from the script (moving them to the .travis.yml file). - I added the content of ci_pre-deploy.sh here (will be deleting ci_pre-deploy bc travis will only run one script and I prefer to use this one). Delete ci_deploy.sh Delete ci_pre-deploy.sh Update .travis.yml Update cibuild.sh Added commands to build and proof back in. Update cibuild.sh What I changed: - commented out the html proofer for now, since a lot is broken in the template. Update .travis.yml What I changed: - added local directory 'site_build' as the directory from which to deploy to s3. Update README.md updated URL for travis build icon Update .travis.yml What I changed: - added travis variable for repo name in deploy section - added travis variable for branch in deploy section Fixes: No bug ID Problem: Travis build breaks bc GH_TOKEN isn't valid for the F5Networks repo. Analysis: I made travis its own github account, generated an access token, encrypted it, and added it to the .travis.yml file. Unit/Robot tests: Update cibuild.sh What I changed: -- replaced GH_TOKEN with GH_USER Update cibuild.sh What I changed: - replaced http clone url with SSH clone url Revert "Update cibuild.sh" This reverts commit e62c1908de7f76c265c2a55f6033ff5e0528b5ed. Revert "Update cibuild.sh" This reverts commit 302b21d445e5fe4ceb517a9441974d8f26901dcc. Revert "Fixes: No bug ID" This reverts commit 232ff82f307946a7500c61469f9fe9d6449c68c4. I fixed the conflict between F5Networks/master and jputrino/master. Fixes: travis builds fail on branch 'site' Problem: travis-ci is unable to build from branch 'site' because it doesn't have a .travis.yml file. Analysis: I added the 'site' branch to the travis blacklist so build will not be triggered when files are pushed to 'site'. Unit/Robot tests: Update .travis.yml What I changed: - Removed GH_TOKEN; replacing with variable GH_USER (which is configured in repos in travis-ci.com) in script. Fixes: Travis build 92 failed - could not install jekyll-pandoc Problem: Travis build #92 failed because it couldn't install the jekyll-pandoc gem. Analysis: I added jekyll-pandoc to the Gemfile. Unit/Robot tests: What I changed: - added a travis variable to the build script in the commit message that should prevent a new build on 'site' branch from kicking off a new build. - defined pygments as the jekyll highlighting tool What I changed: - started explaining the build and deployment process in the README for the f5-openstack-docs repo - made a minor edit to an 'echo' command in the build script What I changed: - entered encrypted env variables for github username and password in the build script so travis can build from the F5Networks repo. Fixes Issue #5 - Travis deployment to s3 is failing What I changed: - I added an encrypted env variable for the AWS Access key for travis-ci Fixes Issue #10 - Travis authentication issues Problem: Travis is unable to push content of site_build folder back to github repo bc authentication fails. Solution: Za and Jeff explained that as long as we have the framework for building the site in github, we don't need the actual site there, too. What I changed: - removed the commands from the cibuild.sh script that told travis to clone the repo and push to the site branch - removed the gh token section from .travis.yml - removed the 'blacklist' section from .travis.yml What I changed: added the command to copy the site build dir over to the local dir back in; the deploy section tells travis to deploy to s3 from $HOME/site_build Fixes: Pull request triggers travis build, but doesn't deploy to Amazon S3 Problem: I took out the command that copied the site build over to the home dir in travis. Analysis: I added the command back in in the previous commit; in this one, I corrected a typo that triggered an error. Unit/Robot tests: Fixes: JIRA - OPENSTACK-28: Docs Website Configuration Problem: We need a website to publicly host the OpenStack docs. Analysis: I made a website. - updated bootstrap template with some F5 Cloud Ready text and links - updated the README with some information about the ci build and deployment process Unit/Robot tests: Fixes: Use pandoc for markdown to html conversion. Problem: I need to use pandoc to convert markdown files to html files. Analysis: I added commands to the jekyll _config.yml file that tell it to use pandoc as the markdown converter. Unit/Robot tests: Fixes: edit _config.yml Problem: n/a Analysis: - change site title to F5 Cloud Ready Unit/Robot tests: Fixes: N/A -- .travis.yml config update Problem: Analysis: - added 'cache: bundler' to travis configs to speed up build - added branch whitelist - removed un-needed token Unit/Robot tests: Fixes: travis build #97 Problem: travis build failed due to an issue with jekyll Analysis: added pre-installation 'gem update' command to ensure latest versions of all gems are being used Unit/Robot tests: Fixes: N/A -- .TRAVIS/YML UPDATE Problem: Analysis: - added "--system" flag to 'gem update' to update the version of Ruby Gems, not the gems themselves (having issues with the latest v of jekyll, so don't want it updated) Unit/Robot tests: Fixes: travis build #98 failed Problem: jekyll could not build site Analysis: could be a ruby version issue; updated .travis.yml to install latest version of ruby gems Unit/Robot tests: Fixes: travis build #99n errored Problem: could not install ruby Analysis: changed to 'rvm: 2.2' Unit/Robot tests: Fixes: N/A -- jekyll build config update Problem: - I changed the markdown converter from jekyll-pandoc back to kramdown (the default) Analysis: Unit/Robot tests: Fixes: N/A -- .travis.yml config update Problem:build #101 'did not deploy to s3 provider because this branch is not permitted' Analysis: added '$TRAVISBRANCH' back to .travis.yml deploy section Unit/Robot tests: Fixes: N/A -- update .travis.yml Problem: Analysis: - change deploy 'acl' setting from 'private' to 'authenticated_read' Unit/Robot tests: Fixes: N/A -- updated index.html Problem: Analysis: Unit/Robot tests: Fixes: N/A -- added repo for 'homeless' docs Problem: - we need a place where all docs can be accessed (from across all sub-dirs) - we need a home for docs that don't clearly fit into any other repo Analysis: - added new _docs repo to house otherwise homeless docs - added index.html file to serve as docs index at a later date Unit/Robot tests: Fixes: changed name of S3 bucket to dev Problem: Analysis: Unit/Robot tests: Fixes: change name of AWS S3 bucket in .travis.yml Problem: Analysis: Unit/Robot tests: Fixes: website maintenance - added project folders using 'f5-*' naming convention - renamed existing project folder _docs to f5-os-docs - removed stock jekyll post from _posts folder - added versioning plugin gem to Gemfile and _config.yml - removed stock jekyll about page Problem: Analysis: Unit/Robot tests: Fixes: Travis build #108 broken: Liquid Exception: Variable '{{if node.fqdn in {'node-compute-1.maas'}' was not properly terminated with regexp: /\}\}/ in f5-os-docs/Demo-and-Testing-Tools-Guide.md Problem: text in a code block incorrectly interpreted as a liquid tag Analysis: added the '{%raw}' and '{%endraw}' tags Unit/Robot tests: Fixes: website configuration Problem: - added plugin to track versioning - added plugin to create project index page from the README in the github repo Analysis: Unit/Robot tests: Fixes: travis build #110 broken Problem: travis can't find dependencies for plugins Analysis: added install step to .travis.yml to bundle install the plugin gems Unit/Robot tests: Fixes: travis build #111 failed Problem: incorrect command usage (bundle install) Analysis: Unit/Robot tests: Fixes: travis build #112 failing Problem: incorrect command usage (bundle install ...) Analysis: Unit/Robot tests: Fixes: travis build #113 failing Problem: error in generate_projects.rb plugin Analysis: Unit/Robot tests: Fixes: travis build #114 failing Problem: cannot load required file in generate_projects.rb plugin Analysis: Unit/Robot tests: Fixes: travis build #115 failing Problem: generate_projects.rb load failing Analysis: Unit/Robot tests: Fixes: travis build #116 failed Problem: Analysis: Unit/Robot tests: Fixes: travis build #117 failing Problem: Analysis: Unit/Robot tests: Fixes: travis build #118 failing Problem: plugin unable to load dependencies - I moved the file out of the _plugins directory to be dealt with later Analysis: Unit/Robot tests: Fixes: travis build #119 failing Problem: Analysis: Unit/Robot tests: Fixes: travis build #119 failing Problem: Analysis: Unit/Robot tests: Fixes: travis build #121 failing Problem: Unable to install dependencies for the jekyll project pages plugin Analysis: I removed the dependencies from the config file and moved the plugins to a holding folder. Unit/Robot tests: Fixes: travis build #121 failing Problem: Liquid Exception: Tag '{%' was not properly terminated with regexp: /\%\}/ in f5-os-docs/Demo-and-Testing-Tools-Guide.md Analysis: - fixed liquid tags - removed 'index.html' (replaced with 'os_landingpage.html') Unit/Robot tests: Fixes: website maintenance Problem: - replaced 'index.html' with /os_landingpage.html' for password-protection on dev site - moved faulty plugins to 'plugins' folder Analysis: Unit/Robot tests: Fixes: travis build #123 failing Problem: travis unable to locate/access f5-openstack-dev bucket Analysis: - I added a new policy to the travis user in s3 that should allow it access to all buckets. Unit/Robot tests: Fixes: website configuration Problem: - templates for head, header, docs landing pages - add liquid tags to os_landingpage.html in place of the head and header Analysis: Unit/Robot tests: Fixes: website maintenance Problem: - configuring layout templates and landing pages Analysis: Unit/Robot tests: Fixes: Website maintenance Problem: Jekyll needs 'index.html' to build the site. We're using 'index.html' as the login page - stored in the s3 bucket for security purposes - so we need to change the name of the file in the build before deploying to the s3 dev bucket. Analysis: - edited the cibuild script to rename index.html to os_landingpage.html after copying files over to travis' home dir Unit/Robot tests: Fixes: website maintenance Problem: - added command to build script to remove the 'index.html' file after renaming it to 'os_landingpage.html' for dev builds Analysis: Unit/Robot tests: Fixes: travis build #126 failing Problem: command 'rm index.html' broke the build because the file wasn't found Analysis: - edited the script to look for the file first, then delete it if found Unit/Robot tests: Fixes: index isn't renamed before deploy to s3 from the develop branch Problem: The index.html file needs to be renamed to os_landingpage.html before the site is deployed to the dev bucket in s3 to ensure proper security. Analysis: - I edited the script to execute this command set earlier (before site build is copied to travis' home dir) Unit/Robot tests: Fixes: added frontmatter to f5-os-docs/* Problem: Analysis: Unit/Robot tests: Fixes: website maintenance Problem: - I added the site url to the config.yml file - I added a link to the f5-os-docs page to the nav bar on the home page - I created a list of the docs in the f5-os-docs folder on the f5-os-docs landing page Analysis: Unit/Robot tests: Fixes: removed section on renaming index file Problem: Analysis: Unit/Robot tests: Fixes: corrected link to f5-os-docs landing page Problem: Analysis: Unit/Robot tests: Fixes: website maintenance Problem: - converted f5-os-docs/index.html to md Analysis: Unit/Robot tests: Fixes: liquid templates Problem: Analysis: Unit/Robot tests: Fixes: add files for tocify Problem: - tocify is a jquery plugin that automatically builds a TOC Analysis: Unit/Robot tests: Fixes: add files for tocify Problem: - tocify is a jquery plugin that automatically builds a TOC Analysis: Unit/Robot tests: Fixes: modified max-width for docs_page toc side bar Fixes: modified max-width for docs_page toc side bar Travis CI and website configurations Update ci_pre-deploy.sh What I changed: I added the travis "$TRAVIS_REPO_SLUG" variable in place of the actual github repo name. Update .travis.yml What I changed: I changed `before_install` to `before_script` because the chmod doesn't need to occur before the dependencies are installed. I then placed the section after the env variables. Update ci_pre-deploy.sh What I changed: - I commented out the if / then statement for now (will test adding that back in once everything is building to my satisfaction) - I added a command to build the site to a new directory (./site_build) Update .travis.yml What I changed: - I replaced the hard-coded repo name with the travis_repo_slug variable. - I replaced the hard-coded branch name with the travis_branch variable. Update .travis.yml I forgot to use $ in the variable names in the last commit. Update cibuild.sh What I changed: - I removed the jekyll and htmlproof executables from the script (moving them to the .travis.yml file). - I added the content of ci_pre-deploy.sh here (will be deleting ci_pre-deploy bc travis will only run one script and I prefer to use this one). Delete ci_deploy.sh Delete ci_pre-deploy.sh Update .travis.yml Update cibuild.sh Added commands to build and proof back in. Update cibuild.sh What I changed: - commented out the html proofer for now, since a lot is broken in the template. Update .travis.yml What I changed: - added local directory 'site_build' as the directory from which to deploy to s3. Update README.md updated URL for travis build icon Update .travis.yml What I changed: - added travis variable for repo name in deploy section - added travis variable for branch in deploy section Fixes: No bug ID Problem: Travis build breaks bc GH_TOKEN isn't valid for the F5Networks repo. Analysis: I made travis its own github account, generated an access token, encrypted it, and added it to the .travis.yml file. Unit/Robot tests: Update cibuild.sh What I changed: -- replaced GH_TOKEN with GH_USER Update cibuild.sh What I changed: - replaced http clone url with SSH clone url Revert "Update cibuild.sh" This reverts commit e62c1908de7f76c265c2a55f6033ff5e0528b5ed. Revert "Update cibuild.sh" This reverts commit 302b21d445e5fe4ceb517a9441974d8f26901dcc. Revert "Fixes: No bug ID" This reverts commit 232ff82f307946a7500c61469f9fe9d6449c68c4. I fixed the conflict between F5Networks/master and jputrino/master. Fixes: travis builds fail on branch 'site' Problem: travis-ci is unable to build from branch 'site' because it doesn't have a .travis.yml file. Analysis: I added the 'site' branch to the travis blacklist so build will not be triggered when files are pushed to 'site'. Unit/Robot tests: Update .travis.yml What I changed: - Removed GH_TOKEN; replacing with variable GH_USER (which is configured in repos in travis-ci.com) in script. Fixes: Travis build 92 failed - could not install jekyll-pandoc Problem: Travis build #92 failed because it couldn't install the jekyll-pandoc gem. Analysis: I added jekyll-pandoc to the Gemfile. Unit/Robot tests: What I changed: - added a travis variable to the build script in the commit message that should prevent a new build on 'site' branch from kicking off a new build. - defined pygments as the jekyll highlighting tool What I changed: - started explaining the build and deployment process in the README for the f5-openstack-docs repo - made a minor edit to an 'echo' command in the build script What I changed: - entered encrypted env variables for github username and password in the build script so travis can build from the F5Networks repo. Fixes Issue #5 - Travis deployment to s3 is failing What I changed: - I added an encrypted env variable for the AWS Access key for travis-ci Fixes Issue #10 - Travis authentication issues Problem: Travis is unable to push content of site_build folder back to github repo bc authentication fails. Solution: Za and Jeff explained that as long as we have the framework for building the site in github, we don't need the actual site there, too. What I changed: - removed the commands from the cibuild.sh script that told travis to clone the repo and push to the site branch - removed the gh token section from .travis.yml - removed the 'blacklist' section from .travis.yml What I changed: added the command to copy the site build dir over to the local dir back in; the deploy section tells travis to deploy to s3 from $HOME/site_build Fixes: Pull request triggers travis build, but doesn't deploy to Amazon S3 Problem: I took out the command that copied the site build over to the home dir in travis. Analysis: I added the command back in in the previous commit; in this one, I corrected a typo that triggered an error. Unit/Robot tests: Fixes: JIRA - OPENSTACK-28: Docs Website Configuration Problem: We need a website to publicly host the OpenStack docs. Analysis: I made a website. - updated bootstrap template with some F5 Cloud Ready text and links - updated the README with some information about the ci build and deployment process Unit/Robot tests: Fixes: Use pandoc for markdown to html conversion. Problem: I need to use pandoc to convert markdown files to html files. Analysis: I added commands to the jekyll _config.yml file that tell it to use pandoc as the markdown converter. Unit/Robot tests: Fixes: edit _config.yml Problem: n/a Analysis: - change site title to F5 Cloud Ready Unit/Robot tests: Fixes: N/A -- .travis.yml config update Problem: Analysis: - added 'cache: bundler' to travis configs to speed up build - added branch whitelist - removed un-needed token Unit/Robot tests: Fixes: travis build #97 Problem: travis build failed due to an issue with jekyll Analysis: added pre-installation 'gem update' command to ensure latest versions of all gems are being used Unit/Robot tests: Fixes: N/A -- .TRAVIS/YML UPDATE Problem: Analysis: - added "--system" flag to 'gem update' to update the version of Ruby Gems, not the gems themselves (having issues with the latest v of jekyll, so don't want it updated) Unit/Robot tests: Fixes: travis build #98 failed Problem: jekyll could not build site Analysis: could be a ruby version issue; updated .travis.yml to install latest version of ruby gems Unit/Robot tests: Fixes: travis build #99n errored Problem: could not install ruby Analysis: changed to 'rvm: 2.2' Unit/Robot tests: Fixes: N/A -- jekyll build config update Problem: - I changed the markdown converter from jekyll-pandoc back to kramdown (the default) Analysis: Unit/Robot tests: Fixes: N/A -- .travis.yml config update Problem:build #101 'did not deploy to s3 provider because this branch is not permitted' Analysis: added '$TRAVISBRANCH' back to .travis.yml deploy section Unit/Robot tests: Fixes: N/A -- update .travis.yml Problem: Analysis: - change deploy 'acl' setting from 'private' to 'authenticated_read' Unit/Robot tests: Fixes: N/A -- updated index.html Problem: Analysis: Unit/Robot tests: Fixes: N/A -- added repo for 'homeless' docs Problem: - we need a place where all docs can be accessed (from across all sub-dirs) - we need a home for docs that don't clearly fit into any other repo Analysis: - added new _docs repo to house otherwise homeless docs - added index.html file to serve as docs index at a later date Unit/Robot tests: Fixes: changed name of S3 bucket to dev Problem: Analysis: Unit/Robot tests: Fixes: change name of AWS S3 bucket in .travis.yml Problem: Analysis: Unit/Robot tests: Fixes: website maintenance - added project folders using 'f5-*' naming convention - renamed existing project folder _docs to f5-os-docs - removed stock jekyll post from _posts folder - added versioning plugin gem to Gemfile and _config.yml - removed stock jekyll about page Problem: Analysis: Unit/Robot tests: Fixes: Travis build #108 broken: Liquid Exception: Variable '{{if node.fqdn in {'node-compute-1.maas'}' was not properly terminated with regexp: /\}\}/ in f5-os-docs/Demo-and-Testing-Tools-Guide.md Problem: text in a code block incorrectly interpreted as a liquid tag Analysis: added the '{%raw}' and '{%endraw}' tags Unit/Robot tests: Fixes: website configuration Problem: - added plugin to track versioning - added plugin to create project index page from the README in the github repo Analysis: Unit/Robot tests: Fixes: travis build #110 broken Problem: travis can't find dependencies for plugins Analysis: added install step to .travis.yml to bundle install the plugin gems Unit/Robot tests: Fixes: travis build #111 failed Problem: incorrect command usage (bundle install) Analysis: Unit/Robot tests: Fixes: travis build #112 failing Problem: incorrect command usage (bundle install ...) Analysis: Unit/Robot tests: Fixes: travis build #113 failing Problem: error in generate_projects.rb plugin Analysis: Unit/Robot tests: Fixes: travis build #114 failing Problem: cannot load required file in generate_projects.rb plugin Analysis: Unit/Robot tests: Fixes: travis build #115 failing Problem: generate_projects.rb load failing Analysis: Unit/Robot tests: Fixes: travis build #116 failed Problem: Analysis: Unit/Robot tests: Fixes: travis build #117 failing Problem: Analysis: Unit/Robot tests: Fixes: travis build #118 failing Problem: plugin unable to load dependencies - I moved the file out of the _plugins directory to be dealt with later Analysis: Unit/Robot tests: Fixes: travis build #119 failing Problem: Analysis: Unit/Robot tests: Fixes: travis build #119 failing Problem: Analysis: Unit/Robot tests: Fixes: travis build #121 failing Problem: Unable to install dependencies for the jekyll project pages plugin Analysis: I removed the dependencies from the config file and moved the plugins to a holding folder. Unit/Robot tests: Fixes: travis build #121 failing Problem: Liquid Exception: Tag '{%' was not properly terminated with regexp: /\%\}/ in f5-os-docs/Demo-and-Testing-Tools-Guide.md Analysis: - fixed liquid tags - removed 'index.html' (replaced with 'os_landingpage.html') Unit/Robot tests: Fixes: website maintenance Problem: - replaced 'index.html' with /os_landingpage.html' for password-protection on dev site - moved faulty plugins to 'plugins' folder Analysis: Unit/Robot tests: Fixes: travis build #123 failing Problem: travis unable to locate/access f5-openstack-dev bucket Analysis: - I added a new policy to the travis user in s3 that should allow it access to all buckets. Unit/Robot tests: Fixes: website configuration Problem: - templates for head, header, docs landing pages - add liquid tags to os_landingpage.html in place of the head and header Analysis: Unit/Robot tests: Fixes: website maintenance Problem: - configuring layout templates and landing pages Analysis: Unit/Robot tests: Fixes: Website maintenance Problem: Jekyll needs 'index.html' to build the site. We're using 'index.html' as the login page - stored in the s3 bucket for security purposes - so we need to change the name of the file in the build before deploying to the s3 dev bucket. Analysis: - edited the cibuild script to rename index.html to os_landingpage.html after copying files over to travis' home dir Unit/Robot tests: Fixes: website maintenance Problem: - added command to build script to remove the 'index.html' file after renaming it to 'os_landingpage.html' for dev builds Analysis: Unit/Robot tests: Fixes: travis build #126 failing Problem: command 'rm index.html' broke the build because the file wasn't found Analysis: - edited the script to look for the file first, then delete it if found Unit/Robot tests: Fixes: index isn't renamed before deploy to s3 from the develop branch Problem: The index.html file needs to be renamed to os_landingpage.html before the site is deployed to the dev bucket in s3 to ensure proper security. Analysis: - I edited the script to execute this command set earlier (before site build is copied to travis' home dir) Unit/Robot tests: Fixes: added frontmatter to f5-os-docs/* Problem: Analysis: Unit/Robot tests: Fixes: website maintenance Problem: - I added the site url to the config.yml file - I added a link to the f5-os-docs page to the nav bar on the home page - I created a list of the docs in the f5-os-docs folder on the f5-os-docs landing page Analysis: Unit/Robot tests: Fixes: removed section on renaming index file Problem: Analysis: Unit/Robot tests: Fixes: corrected link to f5-os-docs landing page Problem: Analysis: Unit/Robot tests: Fixes: website maintenance Problem: - converted f5-os-docs/index.html to md Analysis: Unit/Robot tests: Fixes: liquid templates Problem: Analysis: Unit/Robot tests: Fixes: add files for tocify Problem: - tocify is a jquery plugin that automatically builds a TOC Analysis: Unit/Robot tests: Fixes: add files for tocify Problem: - tocify is a jquery plugin that automatically builds a TOC Analysis: Unit/Robot tests: Fixes: modified max-width for docs_page toc side bar Fixes: modified max-width for docs_page toc side bar Revert "Fixes: modified max-width for docs_page toc side bar"; this commit was a rebase; I'm reverting it because it's causing a merge conflict upstream. This reverts commit bad90d6db7ee8a3c1cb8a361ae1cd58480bcba79. Travis CI and website configurations Update ci_pre-deploy.sh What I changed: I added the travis "$TRAVIS_REPO_SLUG" variable in place of the actual github repo name. Update .travis.yml What I changed: I changed `before_install` to `before_script` because the chmod doesn't need to occur before the dependencies are installed. I then placed the section after the env variables. Update ci_pre-deploy.sh What I changed: - I commented out the if / then statement for now (will test adding that back in once everything is building to my satisfaction) - I added a command to build the site to a new directory (./site_build) Update .travis.yml What I changed: - I replaced the hard-coded repo name with the travis_repo_slug variable. - I replaced the hard-coded branch name with the travis_branch variable. Update .travis.yml I forgot to use $ in the variable names in the last commit. Update cibuild.sh What I changed: - I removed the jekyll and htmlproof executables from the script (moving them to the .travis.yml file). - I added the content of ci_pre-deploy.sh here (will be deleting ci_pre-deploy bc travis will only run one script and I prefer to use this one). Delete ci_deploy.sh Delete ci_pre-deploy.sh Update .travis.yml Update cibuild.sh Added commands to build and proof back in. Update cibuild.sh What I changed: - commented out the html proofer for now, since a lot is broken in the template. Update .travis.yml What I changed: - added local directory 'site_build' as the directory from which to deploy to s3. Update README.md updated URL for travis build icon Update .travis.yml What I changed: - added travis variable for repo name in deploy section - added travis variable for branch in deploy section Fixes: No bug ID Problem: Travis build breaks bc GH_TOKEN isn't valid for the F5Networks repo. Analysis: I made travis its own github account, generated an access token, encrypted it, and added it to the .travis.yml file. Unit/Robot tests: Update cibuild.sh What I changed: -- replaced GH_TOKEN with GH_USER Update cibuild.sh What I changed: - replaced http clone url with SSH clone url Revert "Update cibuild.sh" This reverts commit e62c1908de7f76c265c2a55f6033ff5e0528b5ed. Revert "Update cibuild.sh" This reverts commit 302b21d445e5fe4ceb517a9441974d8f26901dcc. Revert "Fixes: No bug ID" This reverts commit 232ff82f307946a7500c61469f9fe9d6449c68c4. I fixed the conflict between F5Networks/master and jputrino/master. Fixes: travis builds fail on branch 'site' Problem: travis-ci is unable to build from branch 'site' because it doesn't have a .travis.yml file. Analysis: I added the 'site' branch to the travis blacklist so build will not be triggered when files are pushed to 'site'. Unit/Robot tests: Update .travis.yml What I changed: - Removed GH_TOKEN; replacing with variable GH_USER (which is configured in repos in travis-ci.com) in script. Fixes: Travis build 92 failed - could not install jekyll-pandoc Problem: Travis build #92 failed because it couldn't install the jekyll-pandoc gem. Analysis: I added jekyll-pandoc to the Gemfile. Unit/Robot tests: What I changed: - added a travis variable to the build script in the commit message that should prevent a new build on 'site' branch from kicking off a new build. - defined pygments as the jekyll highlighting tool What I changed: - started explaining the build and deployment process in the README for the f5-openstack-docs repo - made a minor edit to an 'echo' command in the build script What I changed: - entered encrypted env variables for github username and password in the build script so travis can build from the F5Networks repo. Fixes Issue #5 - Travis deployment to s3 is failing What I changed: - I added an encrypted env variable for the AWS Access key for travis-ci Fixes Issue #10 - Travis authentication issues Problem: Travis is unable to push content of site_build folder back to github repo bc authentication fails. Solution: Za and Jeff explained that as long as we have the framework for building the site in github, we don't need the actual site there, too. What I changed: - removed the commands from the cibuild.sh script that told travis to clone the repo and push to the site branch - removed the gh token section from .travis.yml - removed the 'blacklist' section from .travis.yml What I changed: added the command to copy the site build dir over to the local dir back in; the deploy section tells travis to deploy to s3 from $HOME/site_build Fixes: Pull request triggers travis build, but doesn't deploy to Amazon S3 Problem: I took out the command that copied the site build over to the home dir in travis. Analysis: I added the command back in in the previous commit; in this one, I corrected a typo that triggered an error. Unit/Robot tests: Fixes: JIRA - OPENSTACK-28: Docs Website Configuration Problem: We need a website to publicly host the OpenStack docs. Analysis: I made a website. - updated bootstrap template with some F5 Cloud Ready text and links - updated the README with some information about the ci build and deployment process Unit/Robot tests: Fixes: Use pandoc for markdown to html conversion. Problem: I need to use pandoc to convert markdown files to html files. Analysis: I added commands to the jekyll _config.yml file that tell it to use pandoc as the markdown converter. Unit/Robot tests: Fixes: edit _config.yml Problem: n/a Analysis: - change site title to F5 Cloud Ready Unit/Robot tests: Fixes: N/A -- .travis.yml config update Problem: Analysis: - added 'cache: bundler' to travis configs to speed up build - added branch whitelist - removed un-needed token Unit/Robot tests: Fixes: travis build #97 Problem: travis build failed due to an issue with jekyll Analysis: added pre-installation 'gem update' command to ensure latest versions of all gems are being used Unit/Robot tests: Fixes: N/A -- .TRAVIS/YML UPDATE Problem: Analysis: - added "--system" flag to 'gem update' to update the version of Ruby Gems, not the gems themselves (having issues with the latest v of jekyll, so don't want it updated) Unit/Robot tests: Fixes: travis build #98 failed Problem: jekyll could not build site Analysis: could be a ruby version issue; updated .travis.yml to install latest version of ruby gems Unit/Robot tests: Fixes: travis build #99n errored Problem: could not install ruby Analysis: changed to 'rvm: 2.2' Unit/Robot tests: Fixes: N/A -- jekyll build config update Problem: - I changed the markdown converter from jekyll-pandoc back to kramdown (the default) Analysis: Unit/Robot tests: Fixes: N/A -- .travis.yml config update Problem:build #101 'did not deploy to s3 provider because this branch is not permitted' Analysis: added '$TRAVISBRANCH' back to .travis.yml deploy section Unit/Robot tests: Fixes: N/A -- update .travis.yml Problem: Analysis: - change deploy 'acl' setting from 'private' to 'authenticated_read' Unit/Robot tests: Fixes: N/A -- updated index.html Problem: Analysis: Unit/Robot tests: Fixes: N/A -- added repo for 'homeless' docs Problem: - we need a place where all docs can be accessed (from across all sub-dirs) - we need a home for docs that don't clearly fit into any other repo Analysis: - added new _docs repo to house otherwise homeless docs - added index.html file to serve as docs index at a later date Unit/Robot tests: Fixes: changed name of S3 bucket to dev Problem: Analysis: Unit/Robot tests: Fixes: change name of AWS S3 bucket in .travis.yml Problem: Analysis: Unit/Robot tests: Fixes: website maintenance - added project folders using 'f5-*' naming convention - renamed existing project folder _docs to f5-os-docs - removed stock jekyll post from _posts folder - added versioning plugin gem to Gemfile and _config.yml - removed stock jekyll about page Problem: Analysis: Unit/Robot tests: Fixes: Travis build #108 broken: Liquid Exception: Variable '{{if node.fqdn in {'node-compute-1.maas'}' was not properly terminated with regexp: /\}\}/ in f5-os-docs/Demo-and-Testing-Tools-Guide.md Problem: text in a code block incorrectly interpreted as a liquid tag Analysis: added the '{%raw}' and '{%endraw}' tags Unit/Robot tests: Fixes: website configuration Problem: - added plugin to track versioning - added plugin to create project index page from the README in the github repo Analysis: Unit/Robot tests: Fixes: travis build #110 broken Problem: travis can't find dependencies for plugins Analysis: added install step to .travis.yml to bundle install the plugin gems Unit/Robot tests: Fixes: travis build #111 failed Problem: incorrect command usage (bundle install) Analysis: Unit/Robot tests: Fixes: travis build #112 failing Problem: incorrect command usage (bundle install ...) Analysis: Unit/Robot tests: Fixes: travis build #113 failing Problem: error in generate_projects.rb plugin Analysis: Unit/Robot tests: Fixes: travis build #114 failing Problem: cannot load required file in generate_projects.rb plugin Analysis: Unit/Robot tests: Fixes: travis build #115 failing Problem: generate_projects.rb load failing Analysis: Unit/Robot tests: Fixes: travis build #116 failed Problem: Analysis: Unit/Robot tests: Fixes: travis build #117 failing Problem: Analysis: Unit/Robot tests: Fixes: travis build #118 failing Problem: plugin unable to load dependencies - I moved the file out of the _plugins directory to be dealt with later Analysis: Unit/Robot tests: Fixes: travis build #119 failing Problem: Analysis: Unit/Robot tests: Fixes: travis build #119 failing Problem: Analysis: Unit/Robot tests: Fixes: travis build #121 failing Problem: Unable to install dependencies for the jekyll project pages plugin Analysis: I removed the dependencies from the config file and moved the plugins to a holding folder. Unit/Robot tests: Fixes: travis build #121 failing Problem: Liquid Exception: Tag '{%' was not properly terminated with regexp: /\%\}/ in f5-os-docs/Demo-and-Testing-Tools-Guide.md Analysis: - fixed liquid tags - removed 'index.html' (replaced with 'os_landingpage.html') Unit/Robot tests: Fixes: website maintenance Problem: - replaced 'index.html' with /os_landingpage.html' for password-protection on dev site - moved faulty plugins to 'plugins' folder Analysis: Unit/Robot tests: Fixes: travis build #123 failing Problem: travis unable to locate/access f5-openstack-dev bucket Analysis: - I added a new policy to the travis user in s3 that should allow it access to all buckets. Unit/Robot tests: Fixes: website configuration Problem: - templates for head, header, docs landing pages - add liquid tags to os_landingpage.html in place of the head and header Analysis: Unit/Robot tests: Fixes: website maintenance Problem: - configuring layout templates and landing pages Analysis: Unit/Robot tests: Fixes: Website maintenance Problem: Jekyll needs 'index.html' to build the site. We're using 'index.html' as the login page - stored in the s3 bucket for security purposes - so we need to change the name of the file in the build before deploying to the s3 dev bucket. Analysis: - edited the cibuild script to rename index.html to os_landingpage.html after copying files over to travis' home dir Unit/Robot tests: Fixes: website maintenance Problem: - added command to build script to remove the 'index.html' file after renaming it to 'os_landingpage.html' for dev builds Analysis: Unit/Robot tests: Fixes: travis build #126 failing Problem: command 'rm index.html' broke the build because the file wasn't found Analysis: - edited the script to look for the file first, then delete it if found Unit/Robot tests: Fixes: index isn't renamed before deploy to s3 from the develop branch Problem: The index.html file needs to be renamed to os_landingpage.html before the site is deployed to the dev bucket in s3 to ensure proper security. Analysis: - I edited the script to execute this command set earlier (before site build is copied to travis' home dir) Unit/Robot tests: Fixes: added frontmatter to f5-os-docs/* Problem: Analysis: Unit/Robot tests: Fixes: website maintenance Problem: - I added the site url to the config.yml file - I added a link to the f5-os-docs page to the nav bar on the home page - I created a list of the docs in the f5-os-docs folder on the f5-os-docs landing page Analysis: Unit/Robot tests: Fixes: removed section on renaming index file Problem: Analysis: Unit/Robot tests: Fixes: corrected link to f5-os-docs landing page Problem: Analysis: Unit/Robot tests: Fixes: website maintenance Problem: - converted f5-os-docs/index.html to md Analysis: Unit/Robot tests: Fixes: liquid templates Problem: Analysis: Unit/Robot tests: Fixes: add files for tocify Problem: - tocify is a jquery plugin that automatically builds a TOC Analysis: Unit/Robot tests: Fixes: add files for tocify Problem: - tocify is a jquery plugin that automatically builds a TOC Analysis: Unit/Robot tests: Fixes: modified max-width for docs_page toc side bar Fixes: modified max-width for docs_page toc side bar Revert "Fixes: modified max-width for docs_page toc side bar"; this commit was a rebase; I'm reverting it because it's causing a merge conflict upstream. This reverts commit bad90d6db7ee8a3c1cb8a361ae1cd58480bcba79. These commits configure the website. Fixes: add out-of-the-box bootstrap files; update frontmatter; update index.html Problem: Analysis: Unit/Robot tests: Fixes: website formatting Problem: Analysis: Unit/Robot tests: Fixes: website formatting Problem: Analysis: Unit/Robot tests: Fixes: website styling with F5 css Problem: Analysis: Unit/Robot tests: Fixes: add jekyll-pandoc-multiple-formats plugin to _plugins dir Problem: Analysis: Unit/Robot tests: Fixes: changes to _config.yml for jekyll-pandoc-multiple-formats Problem: Analysis: Unit/Robot tests: Fixes: travis build #139 failed Problem: Analysis: Unit/Robot tests: Fixes: travis build #140 failed Problem:"/home/travis/build/jputrino/f5-openstack-docs/_plugins/jekyll-pandoc-multiple-formats.rb:4:in `require': cannot load such file -- jekyll-pandoc-multiple-formats/version (LoadError)" Analysis: added '.rb' to jekyll-pandoc-multiple-formats/version Unit/Robot tests: Fixes: travis build #141 failed Problem: plugin dependencies won't load and break the build Analysis: - removed plugin dependencies (moved to 'plugins' folder to revisit later as needed) - modded the _config.yml file: added custom vars, the tocify gem, and switched back to kramdown Unit/Robot tests: Fixes: travis build #142 failed Problem: - added a comma between gems in _config.yml Analysis: Unit/Robot tests: Fixes: changed format for f5-os-docs/* Problem: Analysis: Unit/Robot tests: Fixes: edited '_includes' and '_layouts' files Problem: Analysis: Unit/Robot tests: Fixes: remove duplicate document Problem: - The OpenStack Deployment Tips document lived here and in f5-os-odk. Analysis: - I removed the doc from this repo. Unit/Robot tests: Fixes: website maintenance Problem: - added liquid tags to links for each s3 project folder Analysis: Unit/Robot tests: Fixes: simplify styling Problem: - cut out all style sheets except for main.scss - added f5 styling to _sass sheets Analysis: Unit/Robot tests: Fixes: header.html Problem: Analysis: Unit/Robot tests: Fixes: styling Problem: WIP -- editing index.html to use new Sass style sheets -- editing the sass stylesheets Analysis: Unit/Robot tests: Fixes: travis build #150 failed Problem: Liquid Exception: Unknown tag 'f5' in _includes/header.html, included in _layouts/docs_page.html Analysis: fixed tag Unit/Robot tests: Fixes: travis build #151 failed Problem: Liquid Exception: Tag '{% /f5-os-docs/index.html | prepend:site.url %}' was not properly terminated with regexp: /\%\}/ in _includes/header.html, included in _layouts/docs_page.html Analysis: corrected tag Unit/Robot tests: Fixes: travis build #152 failed Problem: Liquid Exception: Unknown tag 'current' in _includes/footer.html, included in _layouts/docs_page.html Analysis: fixed tag Unit/Robot tests: Fixes: index.html is not rendering correctly Problem: No yaml header Analysis: added yaml header to define layout and page title Unit/Robot tests: Fixes: home page lacks styles Problem: the liquid tags are not correctly formatted to pull in the head, header, and footer Analysis: I corrected the tags. Unit/Robot tests: Fixes: site configurations Problem: The pages are rendering without styles. Analysis: I made edits to the head, header, and index html files. Unit/Robot tests: Fixes: site configuration Problem: styles on website are not rendering Analysis: switched back to bootstrap.css Unit/Robot tests: Fixes: travis s3 config file contains the wrong region Problem: Analysis: I specified the region as 'us-west-2'. Unit/Robot tests: Fixes: website styles are not rendering Problem: the css/sass templates aren't being applied to the page Analysis: I switched back to f5-style.css and associated tags in head.html and header.html. Unit/Robot tests: Fixes: _includes/footer.html Problem: footer needs to be updated to remove unnecessary information Analysis: - I removed the giant github icon - I added the liquid tags to pull in the repo name and version number (these are stored as custom variables in the _config.yml file). Unit/Robot tests: Fixes: edited header.html -- switched back to f5-style tags Problem: Analysis: Unit/Robot tests: Fixes: edited head.html - changed reference to stylesheet to ' site.url/css/f5-styles.css' from 'css/f5-styles.css' Problem: Analysis: Unit/Robot tests: Fixes: removed extra '/' from reference to stylesheet Problem: Analysis: Unit/Robot tests: Fixes: edited head.html Problem: Analysis: diff --git a/_includes/head.html b/_includes/head.html index 840d300..efdcf4c 100644 --- a/_includes/head.html +++ b/_includes/head.html @@ -11,5 +11,5 @@ <link rel="canonical" href="{{ page.url | replace:'index.html','' | prepend: site.baseurl | prepend: site.url }}"> - <link rel="alternate" type="application/rss+xml" title="{{ site.title }}" href="{{ "/feed.xml" | prepend: site.baseurl | prepend: site.url }}" /> + <link rel="alternate" type="application/rss+xml" title="{{ site.title }}" href="{{ "feed.xml" | prepend: site.baseurl | prepend: site.url }}" /> </head> Unit/Robot tests: Fixes: edited index.html Problem: header was displaying twice Analysis: - Head and header were referenced in the template and in the page itself. I removed the reference to head and header from the page. Unit/Robot tests: Fixes: edited footer.html Problem: footer was hard-coded into index.html. Analysis: I moved the content into footer.html and edited for style and content. Unit/Robot tests: Fixes: edit index.html Problem: index.html contained the text for the footer and required style edits. Analysis: I removed the footer content and edited the doc for style. Unit/Robot tests: Fixes: added Font Awesome css and font files. Problem: Analysis: Unit/Robot tests: Fixes: added new background class to f5-styles.css (light gray) Problem: Analysis: Unit/Robot tests: Fixes: header not displaying inline Problem: header missing tag to display list items inline Analysis: added main-nav class to ul Unit/Robot tests: Fixes: nav bar blocks top of home page Problem: added css styling to (hopefully) pull content down Analysis: Unit/Robot tests: Fixes: modified head_for_docs.html and header.html Problem: - head_for_docs.html contained tags that were converting each page into a folder with an index.html file in it - header.html was missing liquid tag 'prepend: site.url' in css ref Analysis: - commented out code that was causing the problem in head_for_docs.html - added tag to header.html Unit/Robot tests: Fixes: the first container is overlapping with the header Problem: Analysis: - added new class to f5-style.css to increase the top margin for the first\ container Unit/Robot tests: Fixes: first container is overlapping with the header Problem: - I used the new class to increase the margin from the top of the page. Analysis: Unit/Robot tests: Fixes: testing out auto-generation of index page Problem: need a way to automatically generate a list of all documentation, organized by category Analysis: - added categories to _config.yml - added an index.html file with the liquid code to pull in the page list - added category tags and "resource: true" to the yaml header for the doc files Unit/Robot tests: Fixes: added 'misc_docs' to the categories list in _config.yml Problem: Analysis: Unit/Robot tests: Fixes: I need a way to automatically generate a docs index page. Problem: - I added categories from the master list in _config.yml to the header of each doc. Analysis: Unit/Robot tests: Fixes: modified css tags in the default layout Problem: Analysis: Unit/Robot tests: Fixes: Changed layout and added a few html tags Problem: Analysis: Unit/Robot tests: Fixes: edited _config.yml: added "baseurl: "f5-os-docs/" Problem: Analysis: Unit/Robot tests: Fixes: I need to set up the styles for the page templates. I'd like to use tocify to generate TOCs for the docs_page template. Problem: - I added a new page template -- home -- that has no styling (to use for home pages). - I added some styling to default. - I created a new layout with the tocify dependencies (css and scripts). - I added some styling and the tocify script to docs_page. Analysis: Unit/Robot tests: Fixes: This commit has the new homepage layout that contains no style tags. Problem: Analysis: Unit/Robot tests: Fixes: I changed the template for the home page to 'homepage'. I also updated the css a bit to make it look better. Problem: Analysis: Unit/Robot tests: Fixes: adding some font files Problem: Analysis: Unit/Robot tests: Fixes: TOC not automatically generated Problem: - I moved the script outside of the body. Analysis: Unit/Robot tests: Fixes: configurations for tocify Problem: I need to use tocify to generate a TOC sidebar automatically Analysis: - I added a new stylesheet. - I added a reference to the new stylesheet to head_for_docs.html. - I edited the docs_page layout. Unit/Robot tests: Fixes: I commented out the gems section from _config.yml and copied over the _lbaasconfig.yml file. Problem: Analysis: Unit/Robot tests: Fixes: corrected location of '_includes' dir in '_lbaasconfig.yml' Problem: Analysis: Unit/Robot tests: Fixes: moved /css, /fonts, /js, /media under new dir -- assets/ Problem: Analysis: Unit/Robot tests: Fixes: remove _lbaasconfig.yml Problem: Analysis: Unit/Robot tests: Travis CI and website configurations Update ci_pre-deploy.sh What I changed: I added the travis "$TRAVIS_REPO_SLUG" variable in place of the actual github repo name. Update .travis.yml What I changed: I changed `before_install` to `before_script` because the chmod doesn't need to occur before the dependencies are installed. I then placed the section after the env variables. Update ci_pre-deploy.sh What I changed: - I commented out the if / then statement for now (will test adding that back in once everything is building to my satisfaction) - I added a command to build the site to a new directory (./site_build) Update .travis.yml What I changed: - I replaced the hard-coded repo name with the travis_repo_slug variable. - I replaced the hard-coded branch name with the travis_branch variable. Update .travis.yml I forgot to use $ in the variable names in the last commit. Update cibuild.sh What I changed: - I removed the jekyll and htmlproof executables from the script (moving them to the .travis.yml file). - I added the content of ci_pre-deploy.sh here (will be deleting ci_pre-deploy bc travis will only run one script and I prefer to use this one). Delete ci_deploy.sh Delete ci_pre-deploy.sh Update .travis.yml Update cibuild.sh Added commands to build and proof back in. Update cibuild.sh What I changed: - commented out the html proofer for now, since a lot is broken in the template. Update .travis.yml What I changed: - added local directory 'site_build' as the directory from which to deploy to s3. Update README.md updated URL for travis build icon Update .travis.yml What I changed: - added travis variable for repo name in deploy section - added travis variable for branch in deploy section Fixes: No bug ID Problem: Travis build breaks bc GH_TOKEN isn't valid for the F5Networks repo. Analysis: I made travis its own github account, generated an access token, encrypted it, and added it to the .travis.yml file. Unit/Robot tests: Update cibuild.sh What I changed: -- replaced GH_TOKEN with GH_USER Update cibuild.sh What I changed: - replaced http clone url with SSH clone url Revert "Update cibuild.sh" This reverts commit e62c1908de7f76c265c2a55f6033ff5e0528b5ed. Revert "Update cibuild.sh" This reverts commit 302b21d445e5fe4ceb517a9441974d8f26901dcc. Revert "Fixes: No bug ID" This reverts commit 232ff82f307946a7500c61469f9fe9d6449c68c4. I fixed the conflict between F5Networks/master and jputrino/master. Fixes: travis builds fail on branch 'site' Problem: travis-ci is unable to build from branch 'site' because it doesn't have a .travis.yml file. Analysis: I added the 'site' branch to the travis blacklist so build will not be triggered when files are pushed to 'site'. Unit/Robot tests: Update .travis.yml What I changed: - Removed GH_TOKEN; replacing with variable GH_USER (which is configured in repos in travis-ci.com) in script. Fixes: Travis build 92 failed - could not install jekyll-pandoc Problem: Travis build #92 failed because it couldn't install the jekyll-pandoc gem. Analysis: I added jekyll-pandoc to the Gemfile. Unit/Robot tests: What I changed: - added a travis variable to the build script in the commit message that should prevent a new build on 'site' branch from kicking off a new build. - defined pygments as the jekyll highlighting tool What I changed: - started explaining the build and deployment process in the README for the f5-openstack-docs repo - made a minor edit to an 'echo' command in the build script What I changed: - entered encrypted env variables for github username and password in the build script so travis can build from the F5Networks repo. Fixes Issue #5 - Travis deployment to s3 is failing What I changed: - I added an encrypted env variable for the AWS Access key for travis-ci Fixes Issue #10 - Travis authentication issues Problem: Travis is unable to push content of site_build folder back to github repo bc authentication fails. Solution: Za and Jeff explained that as long as we have the framework for building the site in github, we don't need the actual site there, too. What I changed: - removed the commands from the cibuild.sh script that told travis to clone the repo and push to the site branch - removed the gh token section from .travis.yml - removed the 'blacklist' section from .travis.yml What I changed: added the command to copy the site build dir over to the local dir back in; the deploy section tells travis to deploy to s3 from $HOME/site_build Fixes: Pull request triggers travis build, but doesn't deploy to Amazon S3 Problem: I took out the command that copied the site build over to the home dir in travis. Analysis: I added the command back in in the previous commit; in this one, I corrected a typo that triggered an error. Unit/Robot tests: Fixes: JIRA - OPENSTACK-28: Docs Website Configuration Problem: We need a website to publicly host the OpenStack docs. Analysis: I made a website. - updated bootstrap template with some F5 Cloud Ready text and links - updated the README with some information about the ci build and deployment process Unit/Robot tests: Fixes: Use pandoc for markdown to html conversion. Problem: I need to use pandoc to convert markdown files to html files. Analysis: I added commands to the jekyll _config.yml file that tell it to use pandoc as the markdown converter. Unit/Robot tests: Fixes: edit _config.yml Problem: n/a Analysis: - change site title to F5 Cloud Ready Unit/Robot tests: Fixes: N/A -- .travis.yml config update Problem: Analysis: - added 'cache: bundler' to travis configs to speed up build - added branch whitelist - removed un-needed token Unit/Robot tests: Fixes: travis build #97 Problem: travis build failed due to an issue with jekyll Analysis: added pre-installation 'gem update' command to ensure latest versions of all gems are being used Unit/Robot tests: Fixes: N/A -- .TRAVIS/YML UPDATE Problem: Analysis: - added "--system" flag to 'gem update' to update the version of Ruby Gems, not the gems themselves (having issues with the latest v of jekyll, so don't want it updated) Unit/Robot tests: Fixes: travis build #98 failed Problem: jekyll could not build site Analysis: could be a ruby version issue; updated .travis.yml to install latest version of ruby gems Unit/Robot tests: Fixes: travis build #99n errored Problem: could not install ruby Analysis: changed to 'rvm: 2.2' Unit/Robot tests: Fixes: N/A -- jekyll build config update Problem: - I changed the markdown converter from jekyll-pandoc back to kramdown (the default) Analysis: Unit/Robot tests: Fixes: N/A -- .travis.yml config update Problem:build #101 'did not deploy to s3 provider because this branch is not permitted' Analysis: added '$TRAVISBRANCH' back to .travis.yml deploy section Unit/Robot tests: Fixes: N/A -- update .travis.yml Problem: Analysis: - change deploy 'acl' setting from 'private' to 'authenticated_read' Unit/Robot tests: Fixes: N/A -- updated index.html Problem: Analysis: Unit/Robot tests: Fixes: N/A -- added repo for 'homeless' docs Problem: - we need a place where all docs can be accessed (from across all sub-dirs) - we need a home for docs that don't clearly fit into any other repo Analysis: - added new _docs repo to house otherwise homeless docs - added index.html file to serve as docs index at a later date Unit/Robot tests: Fixes: changed name of S3 bucket to dev Problem: Analysis: Unit/Robot tests: Fixes: change name of AWS S3 bucket in .travis.yml Problem: Analysis: Unit/Robot tests: Fixes: website maintenance - added project folders using 'f5-*' naming convention - renamed existing project folder _docs to f5-os-docs - removed stock jekyll post from _posts folder - added versioning plugin gem to Gemfile and _config.yml - removed stock jekyll about page Problem: Analysis: Unit/Robot tests: Fixes: Travis build #108 broken: Liquid Exception: Variable '{{if node.fqdn in {'node-compute-1.maas'}' was not properly terminated with regexp: /\}\}/ in f5-os-docs/Demo-and-Testing-Tools-Guide.md Problem: text in a code block incorrectly interpreted as a liquid tag Analysis: added the '{%raw}' and '{%endraw}' tags Unit/Robot tests: Fixes: website configuration Problem: - added plugin to track versioning - added plugin to create project index page from the README in the github repo Analysis: Unit/Robot tests: Fixes: travis build #110 broken Problem: travis can't find dependencies for plugins Analysis: added install step to .travis.yml to bundle install the plugin gems Unit/Robot tests: Fixes: travis build #111 failed Problem: incorrect command usage (bundle install) Analysis: Unit/Robot tests: Fixes: travis build #112 failing Problem: incorrect command usage (bundle install ...) Analysis: Unit/Robot tests: Fixes: travis build #113 failing Problem: error in generate_projects.rb plugin Analysis: Unit/Robot tests: Fixes: travis build #114 failing Problem: cannot load required file in generate_projects.rb plugin Analysis: Unit/Robot tests: Fixes: travis build #115 failing Problem: generate_projects.rb load failing Analysis: Unit/Robot tests: Fixes: travis build #116 failed Problem: Analysis: Unit/Robot tests: Fixes: travis build #117 failing Problem: Analysis: Unit/Robot tests: Fixes: travis build #118 failing Problem: plugin unable to load dependencies - I moved the file out of the _plugins directory to be dealt with later Analysis: Unit/Robot tests: Fixes: travis build #119 failing Problem: Analysis: Unit/Robot tests: Fixes: travis build #119 failing Problem: Analysis: Unit/Robot tests: Fixes: travis build #121 failing Problem: Unable to install dependencies for the jekyll project pages plugin Analysis: I removed the dependencies from the config file and moved the plugins to a holding folder. Unit/Robot tests: Fixes: travis build #121 failing Problem: Liquid Exception: Tag '{%' was not properly terminated with regexp: /\%\}/ in f5-os-docs/Demo-and-Testing-Tools-Guide.md Analysis: - fixed liquid tags - removed 'index.html' (replaced with 'os_landingpage.html') Unit/Robot tests: Fixes: website maintenance Problem: - replaced 'index.html' with /os_landingpage.html' for password-protection on dev site - moved faulty plugins to 'plugins' folder Analysis: Unit/Robot tests: Fixes: travis build #123 failing Problem: travis unable to locate/access f5-openstack-dev bucket Analysis: - I added a new policy to the travis user in s3 that should allow it access to all buckets. Unit/Robot tests: Fixes: website configuration Problem: - templates for head, header, docs landing pages - add liquid tags to os_landingpage.html in place of the head and header Analysis: Unit/Robot tests: Fixes: website maintenance Problem: - configuring layout templates and landing pages Analysis: Unit/Robot tests: Fixes: Website maintenance Problem: Jekyll needs 'index.html' to build the site. We're using 'index.html' as the login page - stored in the s3 bucket for security purposes - so we need to change the name of the file in the build before deploying to the s3 dev bucket. Analysis: - edited the cibuild script to rename index.html to os_landingpage.html after copying files over to travis' home dir Unit/Robot tests: Fixes: website maintenance Problem: - added command to build script to remove the 'index.html' file after renaming it to 'os_landingpage.html' for dev builds Analysis: Unit/Robot tests: Fixes: travis build #126 failing Problem: command 'rm index.html' broke the build because the file wasn't found Analysis: - edited the script to look for the file first, then delete it if found Unit/Robot tests: Fixes: index isn't renamed before deploy to s3 from the develop branch Problem: The index.html file needs to be renamed to os_landingpage.html before the site is deployed to the dev bucket in s3 to ensure proper security. Analysis: - I edited the script to execute this command set earlier (before site build is copied to travis' home dir) Unit/Robot tests: Fixes: added frontmatter to f5-os-docs/* Problem: Analysis: Unit/Robot tests: Fixes: website maintenance Problem: - I added the site url to the config.yml file - I added a link to the f5-os-docs page to the nav bar on the home page - I created a list of the docs in the f5-os-docs folder on the f5-os-docs landing page Analysis: Unit/Robot tests: Fixes: removed section on renaming index file Problem: Analysis: Unit/Robot tests: Fixes: corrected link to f5-os-docs landing page Problem: Analysis: Unit/Robot tests: Fixes: website maintenance Problem: - converted f5-os-docs/index.html to md Analysis: Unit/Robot tests: Fixes: liquid templates Problem: Analysis: Unit/Robot tests: Fixes: add files for tocify Problem: - tocify is a jquery plugin that automatically builds a TOC Analysis: Unit/Robot tests: Fixes: add files for tocify Problem: - tocify is a jquery plugin that automatically builds a TOC Analysis: Unit/Robot tests: Fixes: modified max-width for docs_page toc side bar Fixes: modified max-width for docs_page toc side bar Revert "Fixes: modified max-width for docs_page toc side bar"; this commit was a rebase; I'm reverting it because it's causing a merge conflict upstream. This reverts commit bad90d6db7ee8a3c1cb8a361ae1cd58480bcba79. These commits configure the website. Fixes: add out-of-the-box bootstrap files; update frontmatter; update index.html Problem: Analysis: Unit/Robot tests: Fixes: website formatting Problem: Analysis: Unit/Robot tests: Fixes: website formatting Problem: Analysis: Unit/Robot tests: Fixes: website styling with F5 css Problem: Analysis: Unit/Robot tests: Fixes: add jekyll-pandoc-multiple-formats plugin to _plugins dir Problem: Analysis: Unit/Robot tests: Fixes: changes to _config.yml for jekyll-pandoc-multiple-formats Problem: Analysis: Unit/Robot tests: Fixes: travis build #139 failed Problem: Analysis: Unit/Robot tests: Fixes: travis build #140 failed Problem:"/home/travis/build/jputrino/f5-openstack-docs/_plugins/jekyll-pandoc-multiple-formats.rb:4:in `require': cannot load such file -- jekyll-pandoc-multiple-formats/version (LoadError)" Analysis: added '.rb' to jekyll-pandoc-multiple-formats/version Unit/Robot tests: Fixes: travis build #141 failed Problem: plugin dependencies won't load and break the build Analysis: - removed plugin dependencies (moved to 'plugins' folder to revisit later as needed) - modded the _config.yml file: added custom vars, the tocify gem, and switched back to kramdown Unit/Robot tests: Fixes: travis build #142 failed Problem: - added a comma between gems in _config.yml Analysis: Unit/Robot tests: Fixes: changed format for f5-o…

…develop s CI and website configurations Update ci_pre-deploy.sh What I changed: I added the travis "$TRAVIS_REPO_SLUG" variable in place of the actual github repo name. Update .travis.yml What I changed: I changed `before_install` to `before_script` because the chmod doesn't need to occur before the dependencies are installed. I then placed the section after the env variables. Update ci_pre-deploy.sh What I changed: - I commented out the if / then statement for now (will test adding that back in once everything is building to my satisfaction) - I added a command to build the site to a new directory (./site_build) Update .travis.yml What I changed: - I replaced the hard-coded repo name with the travis_repo_slug variable. - I replaced the hard-coded branch name with the travis_branch variable. Update .travis.yml I forgot to use $ in the variable names in the last commit. Update cibuild.sh What I changed: - I removed the jekyll and htmlproof executables from the script (moving them to the .travis.yml file). - I added the content of ci_pre-deploy.sh here (will be deleting ci_pre-deploy bc travis will only run one script and I prefer to use this one). Delete ci_deploy.sh Delete ci_pre-deploy.sh Update .travis.yml Update cibuild.sh Added commands to build and proof back in. Update cibuild.sh What I changed: - commented out the html proofer for now, since a lot is broken in the template. Update .travis.yml What I changed: - added local directory 'site_build' as the directory from which to deploy to s3. Update README.md updated URL for travis build icon Update .travis.yml What I changed: - added travis variable for repo name in deploy section - added travis variable for branch in deploy section Fixes: No bug ID Problem: Travis build breaks bc GH_TOKEN isn't valid for the F5Networks repo. Analysis: I made travis its own github account, generated an access token, encrypted it, and added it to the .travis.yml file. Unit/Robot tests: Update cibuild.sh What I changed: -- replaced GH_TOKEN with GH_USER Update cibuild.sh What I changed: - replaced http clone url with SSH clone url Revert "Update cibuild.sh" This reverts commit e62c1908de7f76c265c2a55f6033ff5e0528b5ed. Revert "Update cibuild.sh" This reverts commit 302b21d445e5fe4ceb517a9441974d8f26901dcc. Travis CI and website configurations Update ci_pre-deploy.sh What I changed: I added the travis "$TRAVIS_REPO_SLUG" variable in place of the actual github repo name. Update .travis.yml What I changed: I changed `before_install` to `before_script` because the chmod doesn't need to occur before the dependencies are installed. I then placed the section after the env variables. Update ci_pre-deploy.sh What I changed: - I commented out the if / then statement for now (will test adding that back in once everything is building to my satisfaction) - I added a command to build the site to a new directory (./site_build) Update .travis.yml What I changed: - I replaced the hard-coded repo name with the travis_repo_slug variable. - I replaced the hard-coded branch name with the travis_branch variable. Update .travis.yml I forgot to use $ in the variable names in the last commit. Update cibuild.sh What I changed: - I removed the jekyll and htmlproof executables from the script (moving them to the .travis.yml file). - I added the content of ci_pre-deploy.sh here (will be deleting ci_pre-deploy bc travis will only run one script and I prefer to use this one). Delete ci_deploy.sh Delete ci_pre-deploy.sh Update .travis.yml Update cibuild.sh Added commands to build and proof back in. Update cibuild.sh What I changed: - commented out the html proofer for now, since a lot is broken in the template. Update .travis.yml What I changed: - added local directory 'site_build' as the directory from which to deploy to s3. Update README.md updated URL for travis build icon Update .travis.yml What I changed: - added travis variable for repo name in deploy section - added travis variable for branch in deploy section Fixes: No bug ID Problem: Travis build breaks bc GH_TOKEN isn't valid for the F5Networks repo. Analysis: I made travis its own github account, generated an access token, encrypted it, and added it to the .travis.yml file. Unit/Robot tests: Update cibuild.sh What I changed: -- replaced GH_TOKEN with GH_USER Update cibuild.sh What I changed: - replaced http clone url with SSH clone url Revert "Update cibuild.sh" This reverts commit e62c1908de7f76c265c2a55f6033ff5e0528b5ed. Revert "Update cibuild.sh" This reverts commit 302b21d445e5fe4ceb517a9441974d8f26901dcc. Revert "Fixes: No bug ID" This reverts commit 232ff82f307946a7500c61469f9fe9d6449c68c4. I fixed the conflict between F5Networks/master and jputrino/master. Fixes: travis builds fail on branch 'site' Problem: travis-ci is unable to build from branch 'site' because it doesn't have a .travis.yml file. Analysis: I added the 'site' branch to the travis blacklist so build will not be triggered when files are pushed to 'site'. Unit/Robot tests: Update .travis.yml What I changed: - Removed GH_TOKEN; replacing with variable GH_USER (which is configured in repos in travis-ci.com) in script. Fixes: Travis build 92 failed - could not install jekyll-pandoc Problem: Travis build #92 failed because it couldn't install the jekyll-pandoc gem. Analysis: I added jekyll-pandoc to the Gemfile. Unit/Robot tests: What I changed: - added a travis variable to the build script in the commit message that should prevent a new build on 'site' branch from kicking off a new build. - defined pygments as the jekyll highlighting tool What I changed: - started explaining the build and deployment process in the README for the f5-openstack-docs repo - made a minor edit to an 'echo' command in the build script What I changed: - entered encrypted env variables for github username and password in the build script so travis can build from the F5Networks repo. Fixes Issue #5 - Travis deployment to s3 is failing What I changed: - I added an encrypted env variable for the AWS Access key for travis-ci Fixes Issue #10 - Travis authentication issues Problem: Travis is unable to push content of site_build folder back to github repo bc authentication fails. Solution: Za and Jeff explained that as long as we have the framework for building the site in github, we don't need the actual site there, too. What I changed: - removed the commands from the cibuild.sh script that told travis to clone the repo and push to the site branch - removed the gh token section from .travis.yml - removed the 'blacklist' section from .travis.yml What I changed: added the command to copy the site build dir over to the local dir back in; the deploy section tells travis to deploy to s3 from $HOME/site_build Fixes: Pull request triggers travis build, but doesn't deploy to Amazon S3 Problem: I took out the command that copied the site build over to the home dir in travis. Analysis: I added the command back in in the previous commit; in this one, I corrected a typo that triggered an error. Unit/Robot tests: Fixes: JIRA - OPENSTACK-28: Docs Website Configuration Problem: We need a website to publicly host the OpenStack docs. Analysis: I made a website. - updated bootstrap template with some F5 Cloud Ready text and links - updated the README with some information about the ci build and deployment process Unit/Robot tests: Fixes: Use pandoc for markdown to html conversion. Problem: I need to use pandoc to convert markdown files to html files. Analysis: I added commands to the jekyll _config.yml file that tell it to use pandoc as the markdown converter. Unit/Robot tests: Fixes: edit _config.yml Problem: n/a Analysis: - change site title to F5 Cloud Ready Unit/Robot tests: Fixes: N/A -- .travis.yml config update Problem: Analysis: - added 'cache: bundler' to travis configs to speed up build - added branch whitelist - removed un-needed token Unit/Robot tests: Fixes: travis build #97 Problem: travis build failed due to an issue with jekyll Analysis: added pre-installation 'gem update' command to ensure latest versions of all gems are being used Unit/Robot tests: Fixes: N/A -- .TRAVIS/YML UPDATE Problem: Analysis: - added "--system" flag to 'gem update' to update the version of Ruby Gems, not the gems themselves (having issues with the latest v of jekyll, so don't want it updated) Unit/Robot tests: Fixes: travis build #98 failed Problem: jekyll could not build site Analysis: could be a ruby version issue; updated .travis.yml to install latest version of ruby gems Unit/Robot tests: Fixes: travis build #99n errored Problem: could not install ruby Analysis: changed to 'rvm: 2.2' Unit/Robot tests: Fixes: N/A -- jekyll build config update Problem: - I changed the markdown converter from jekyll-pandoc back to kramdown (the default) Analysis: Unit/Robot tests: Fixes: N/A -- .travis.yml config update Problem:build #101 'did not deploy to s3 provider because this branch is not permitted' Analysis: added '$TRAVISBRANCH' back to .travis.yml deploy section Unit/Robot tests: Fixes: N/A -- update .travis.yml Problem: Analysis: - change deploy 'acl' setting from 'private' to 'authenticated_read' Unit/Robot tests: Fixes: N/A -- updated index.html Problem: Analysis: Unit/Robot tests: Fixes: N/A -- added repo for 'homeless' docs Problem: - we need a place where all docs can be accessed (from across all sub-dirs) - we need a home for docs that don't clearly fit into any other repo Analysis: - added new _docs repo to house otherwise homeless docs - added index.html file to serve as docs index at a later date Unit/Robot tests: Fixes: changed name of S3 bucket to dev Problem: Analysis: Unit/Robot tests: Fixes: change name of AWS S3 bucket in .travis.yml Problem: Analysis: Unit/Robot tests: Fixes: website maintenance - added project folders using 'f5-*' naming convention - renamed existing project folder _docs to f5-os-docs - removed stock jekyll post from _posts folder - added versioning plugin gem to Gemfile and _config.yml - removed stock jekyll about page Problem: Analysis: Unit/Robot tests: Fixes: Travis build #108 broken: Liquid Exception: Variable '{{if node.fqdn in {'node-compute-1.maas'}' was not properly terminated with regexp: /\}\}/ in f5-os-docs/Demo-and-Testing-Tools-Guide.md Problem: text in a code block incorrectly interpreted as a liquid tag Analysis: added the '{%raw}' and '{%endraw}' tags Unit/Robot tests: Fixes: website configuration Problem: - added plugin to track versioning - added plugin to create project index page from the README in the github repo Analysis: Unit/Robot tests: Fixes: travis build #110 broken Problem: travis can't find dependencies for plugins Analysis: added install step to .travis.yml to bundle install the plugin gems Unit/Robot tests: Fixes: travis build #111 failed Problem: incorrect command usage (bundle install) Analysis: Unit/Robot tests: Fixes: travis build #112 failing Problem: incorrect command usage (bundle install ...) Analysis: Unit/Robot tests: Fixes: travis build #113 failing Problem: error in generate_projects.rb plugin Analysis: Unit/Robot tests: Fixes: travis build #114 failing Problem: cannot load required file in generate_projects.rb plugin Analysis: Unit/Robot tests: Fixes: travis build #115 failing Problem: generate_projects.rb load failing Analysis: Unit/Robot tests: Fixes: travis build #116 failed Problem: Analysis: Unit/Robot tests: Fixes: travis build #117 failing Problem: Analysis: Unit/Robot tests: Fixes: travis build #118 failing Problem: plugin unable to load dependencies - I moved the file out of the _plugins directory to be dealt with later Analysis: Unit/Robot tests: Fixes: travis build #119 failing Problem: Analysis: Unit/Robot tests: Fixes: travis build #119 failing Problem: Analysis: Unit/Robot tests: Fixes: travis build #121 failing Problem: Unable to install dependencies for the jekyll project pages plugin Analysis: I removed the dependencies from the config file and moved the plugins to a holding folder. Unit/Robot tests: Fixes: travis build #121 failing Problem: Liquid Exception: Tag '{%' was not properly terminated with regexp: /\%\}/ in f5-os-docs/Demo-and-Testing-Tools-Guide.md Analysis: - fixed liquid tags - removed 'index.html' (replaced with 'os_landingpage.html') Unit/Robot tests: Fixes: website maintenance Problem: - replaced 'index.html' with /os_landingpage.html' for password-protection on dev site - moved faulty plugins to 'plugins' folder Analysis: Unit/Robot tests: Fixes: travis build #123 failing Problem: travis unable to locate/access f5-openstack-dev bucket Analysis: - I added a new policy to the travis user in s3 that should allow it access to all buckets. Unit/Robot tests: Fixes: website configuration Problem: - templates for head, header, docs landing pages - add liquid tags to os_landingpage.html in place of the head and header Analysis: Unit/Robot tests: Fixes: website maintenance Problem: - configuring layout templates and landing pages Analysis: Unit/Robot tests: Fixes: Website maintenance Problem: Jekyll needs 'index.html' to build the site. We're using 'index.html' as the login page - stored in the s3 bucket for security purposes - so we need to change the name of the file in the build before deploying to the s3 dev bucket. Analysis: - edited the cibuild script to rename index.html to os_landingpage.html after copying files over to travis' home dir Unit/Robot tests: Fixes: website maintenance Problem: - added command to build script to remove the 'index.html' file after renaming it to 'os_landingpage.html' for dev builds Analysis: Unit/Robot tests: Fixes: travis build #126 failing Problem: command 'rm index.html' broke the build because the file wasn't found Analysis: - edited the script to look for the file first, then delete it if found Unit/Robot tests: Fixes: index isn't renamed before deploy to s3 from the develop branch Problem: The index.html file needs to be renamed to os_landingpage.html before the site is deployed to the dev bucket in s3 to ensure proper security. Analysis: - I edited the script to execute this command set earlier (before site build is copied to travis' home dir) Unit/Robot tests: Fixes: added frontmatter to f5-os-docs/* Problem: Analysis: Unit/Robot tests: Fixes: website maintenance Problem: - I added the site url to the config.yml file - I added a link to the f5-os-docs page to the nav bar on the home page - I created a list of the docs in the f5-os-docs folder on the f5-os-docs landing page Analysis: Unit/Robot tests: Fixes: removed section on renaming index file Problem: Analysis: Unit/Robot tests: Fixes: corrected link to f5-os-docs landing page Problem: Analysis: Unit/Robot tests: Fixes: website maintenance Problem: - converted f5-os-docs/index.html to md Analysis: Unit/Robot tests: Fixes: liquid templates Problem: Analysis: Unit/Robot tests: Fixes: add files for tocify Problem: - tocify is a jquery plugin that automatically builds a TOC Analysis: Unit/Robot tests: Fixes: add files for tocify Problem: - tocify is a jquery plugin that automatically builds a TOC Analysis: Unit/Robot tests: Fixes: modified max-width for docs_page toc side bar Fixes: modified max-width for docs_page toc side bar Travis CI and website configurations Update ci_pre-deploy.sh What I changed: I added the travis "$TRAVIS_REPO_SLUG" variable in place of the actual github repo name. Update .travis.yml What I changed: I changed `before_install` to `before_script` because the chmod doesn't need to occur before the dependencies are installed. I then placed the section after the env variables. Update ci_pre-deploy.sh What I changed: - I commented out the if / then statement for now (will test adding that back in once everything is building to my satisfaction) - I added a command to build the site to a new directory (./site_build) Update .travis.yml What I changed: - I replaced the hard-coded repo name with the travis_repo_slug variable. - I replaced the hard-coded branch name with the travis_branch variable. Update .travis.yml I forgot to use $ in the variable names in the last commit. Update cibuild.sh What I changed: - I removed the jekyll and htmlproof executables from the script (moving them to the .travis.yml file). - I added the content of ci_pre-deploy.sh here (will be deleting ci_pre-deploy bc travis will only run one script and I prefer to use this one). Delete ci_deploy.sh Delete ci_pre-deploy.sh Update .travis.yml Update cibuild.sh Added commands to build and proof back in. Update cibuild.sh What I changed: - commented out the html proofer for now, since a lot is broken in the template. Update .travis.yml What I changed: - added local directory 'site_build' as the directory from which to deploy to s3. Update README.md updated URL for travis build icon Update .travis.yml What I changed: - added travis variable for repo name in deploy section - added travis variable for branch in deploy section Fixes: No bug ID Problem: Travis build breaks bc GH_TOKEN isn't valid for the F5Networks repo. Analysis: I made travis its own github account, generated an access token, encrypted it, and added it to the .travis.yml file. Unit/Robot tests: Update cibuild.sh What I changed: -- replaced GH_TOKEN with GH_USER Update cibuild.sh What I changed: - replaced http clone url with SSH clone url Revert "Update cibuild.sh" This reverts commit e62c1908de7f76c265c2a55f6033ff5e0528b5ed. Revert "Update cibuild.sh" This reverts commit 302b21d445e5fe4ceb517a9441974d8f26901dcc. Revert "Fixes: No bug ID" This reverts commit 232ff82f307946a7500c61469f9fe9d6449c68c4. I fixed the conflict between F5Networks/master and jputrino/master. Fixes: travis builds fail on branch 'site' Problem: travis-ci is unable to build from branch 'site' because it doesn't have a .travis.yml file. Analysis: I added the 'site' branch to the travis blacklist so build will not be triggered when files are pushed to 'site'. Unit/Robot tests: Update .travis.yml What I changed: - Removed GH_TOKEN; replacing with variable GH_USER (which is configured in repos in travis-ci.com) in script. Fixes: Travis build 92 failed - could not install jekyll-pandoc Problem: Travis build #92 failed because it couldn't install the jekyll-pandoc gem. Analysis: I added jekyll-pandoc to the Gemfile. Unit/Robot tests: What I changed: - added a travis variable to the build script in the commit message that should prevent a new build on 'site' branch from kicking off a new build. - defined pygments as the jekyll highlighting tool What I changed: - started explaining the build and deployment process in the README for the f5-openstack-docs repo - made a minor edit to an 'echo' command in the build script What I changed: - entered encrypted env variables for github username and password in the build script so travis can build from the F5Networks repo. Fixes Issue #5 - Travis deployment to s3 is failing What I changed: - I added an encrypted env variable for the AWS Access key for travis-ci Fixes Issue #10 - Travis authentication issues Problem: Travis is unable to push content of site_build folder back to github repo bc authentication fails. Solution: Za and Jeff explained that as long as we have the framework for building the site in github, we don't need the actual site there, too. What I changed: - removed the commands from the cibuild.sh script that told travis to clone the repo and push to the site branch - removed the gh token section from .travis.yml - removed the 'blacklist' section from .travis.yml What I changed: added the command to copy the site build dir over to the local dir back in; the deploy section tells travis to deploy to s3 from $HOME/site_build Fixes: Pull request triggers travis build, but doesn't deploy to Amazon S3 Problem: I took out the command that copied the site build over to the home dir in travis. Analysis: I added the command back in in the previous commit; in this one, I corrected a typo that triggered an error. Unit/Robot tests: Fixes: JIRA - OPENSTACK-28: Docs Website Configuration Problem: We need a website to publicly host the OpenStack docs. Analysis: I made a website. - updated bootstrap template with some F5 Cloud Ready text and links - updated the README with some information about the ci build and deployment process Unit/Robot tests: Fixes: Use pandoc for markdown to html conversion. Problem: I need to use pandoc to convert markdown files to html files. Analysis: I added commands to the jekyll _config.yml file that tell it to use pandoc as the markdown converter. Unit/Robot tests: Fixes: edit _config.yml Problem: n/a Analysis: - change site title to F5 Cloud Ready Unit/Robot tests: Fixes: N/A -- .travis.yml config update Problem: Analysis: - added 'cache: bundler' to travis configs to speed up build - added branch whitelist - removed un-needed token Unit/Robot tests: Fixes: travis build #97 Problem: travis build failed due to an issue with jekyll Analysis: added pre-installation 'gem update' command to ensure latest versions of all gems are being used Unit/Robot tests: Fixes: N/A -- .TRAVIS/YML UPDATE Problem: Analysis: - added "--system" flag to 'gem update' to update the version of Ruby Gems, not the gems themselves (having issues with the latest v of jekyll, so don't want it updated) Unit/Robot tests: Fixes: travis build #98 failed Problem: jekyll could not build site Analysis: could be a ruby version issue; updated .travis.yml to install latest version of ruby gems Unit/Robot tests: Fixes: travis build #99n errored Problem: could not install ruby Analysis: changed to 'rvm: 2.2' Unit/Robot tests: Fixes: N/A -- jekyll build config update Problem: - I changed the markdown converter from jekyll-pandoc back to kramdown (the default) Analysis: Unit/Robot tests: Fixes: N/A -- .travis.yml config update Problem:build #101 'did not deploy to s3 provider because this branch is not permitted' Analysis: added '$TRAVISBRANCH' back to .travis.yml deploy section Unit/Robot tests: Fixes: N/A -- update .travis.yml Problem: Analysis: - change deploy 'acl' setting from 'private' to 'authenticated_read' Unit/Robot tests: Fixes: N/A -- updated index.html Problem: Analysis: Unit/Robot tests: Fixes: N/A -- added repo for 'homeless' docs Problem: - we need a place where all docs can be accessed (from across all sub-dirs) - we need a home for docs that don't clearly fit into any other repo Analysis: - added new _docs repo to house otherwise homeless docs - added index.html file to serve as docs index at a later date Unit/Robot tests: Fixes: changed name of S3 bucket to dev Problem: Analysis: Unit/Robot tests: Fixes: change name of AWS S3 bucket in .travis.yml Problem: Analysis: Unit/Robot tests: Fixes: website maintenance - added project folders using 'f5-*' naming convention - renamed existing project folder _docs to f5-os-docs - removed stock jekyll post from _posts folder - added versioning plugin gem to Gemfile and _config.yml - removed stock jekyll about page Problem: Analysis: Unit/Robot tests: Fixes: Travis build #108 broken: Liquid Exception: Variable '{{if node.fqdn in {'node-compute-1.maas'}' was not properly terminated with regexp: /\}\}/ in f5-os-docs/Demo-and-Testing-Tools-Guide.md Problem: text in a code block incorrectly interpreted as a liquid tag Analysis: added the '{%raw}' and '{%endraw}' tags Unit/Robot tests: Fixes: website configuration Problem: - added plugin to track versioning - added plugin to create project index page from the README in the github repo Analysis: Unit/Robot tests: Fixes: travis build #110 broken Problem: travis can't find dependencies for plugins Analysis: added install step to .travis.yml to bundle install the plugin gems Unit/Robot tests: Fixes: travis build #111 failed Problem: incorrect command usage (bundle install) Analysis: Unit/Robot tests: Fixes: travis build #112 failing Problem: incorrect command usage (bundle install ...) Analysis: Unit/Robot tests: Fixes: travis build #113 failing Problem: error in generate_projects.rb plugin Analysis: Unit/Robot tests: Fixes: travis build #114 failing Problem: cannot load required file in generate_projects.rb plugin Analysis: Unit/Robot tests: Fixes: travis build #115 failing Problem: generate_projects.rb load failing Analysis: Unit/Robot tests: Fixes: travis build #116 failed Problem: Analysis: Unit/Robot tests: Fixes: travis build #117 failing Problem: Analysis: Unit/Robot tests: Fixes: travis build #118 failing Problem: plugin unable to load dependencies - I moved the file out of the _plugins directory to be dealt with later Analysis: Unit/Robot tests: Fixes: travis build #119 failing Problem: Analysis: Unit/Robot tests: Fixes: travis build #119 failing Problem: Analysis: Unit/Robot tests: Fixes: travis build #121 failing Problem: Unable to install dependencies for the jekyll project pages plugin Analysis: I removed the dependencies from the config file and moved the plugins to a holding folder. Unit/Robot tests: Fixes: travis build #121 failing Problem: Liquid Exception: Tag '{%' was not properly terminated with regexp: /\%\}/ in f5-os-docs/Demo-and-Testing-Tools-Guide.md Analysis: - fixed liquid tags - removed 'index.html' (replaced with 'os_landingpage.html') Unit/Robot tests: Fixes: website maintenance Problem: - replaced 'index.html' with /os_landingpage.html' for password-protection on dev site - moved faulty plugins to 'plugins' folder Analysis: Unit/Robot tests: Fixes: travis build #123 failing Problem: travis unable to locate/access f5-openstack-dev bucket Analysis: - I added a new policy to the travis user in s3 that should allow it access to all buckets. Unit/Robot tests: Fixes: website configuration Problem: - templates for head, header, docs landing pages - add liquid tags to os_landingpage.html in place of the head and header Analysis: Unit/Robot tests: Fixes: website maintenance Problem: - configuring layout templates and landing pages Analysis: Unit/Robot tests: Fixes: Website maintenance Problem: Jekyll needs 'index.html' to build the site. We're using 'index.html' as the login page - stored in the s3 bucket for security purposes - so we need to change the name of the file in the build before deploying to the s3 dev bucket. Analysis: - edited the cibuild script to rename index.html to os_landingpage.html after copying files over to travis' home dir Unit/Robot tests: Fixes: website maintenance Problem: - added command to build script to remove the 'index.html' file after renaming it to 'os_landingpage.html' for dev builds Analysis: Unit/Robot tests: Fixes: travis build #126 failing Problem: command 'rm index.html' broke the build because the file wasn't found Analysis: - edited the script to look for the file first, then delete it if found Unit/Robot tests: Fixes: index isn't renamed before deploy to s3 from the develop branch Problem: The index.html file needs to be renamed to os_landingpage.html before the site is deployed to the dev bucket in s3 to ensure proper security. Analysis: - I edited the script to execute this command set earlier (before site build is copied to travis' home dir) Unit/Robot tests: Fixes: added frontmatter to f5-os-docs/* Problem: Analysis: Unit/Robot tests: Fixes: website maintenance Problem: - I added the site url to the config.yml file - I added a link to the f5-os-docs page to the nav bar on the home page - I created a list of the docs in the f5-os-docs folder on the f5-os-docs landing page Analysis: Unit/Robot tests: Fixes: removed section on renaming index file Problem: Analysis: Unit/Robot tests: Fixes: corrected link to f5-os-docs landing page Problem: Analysis: Unit/Robot tests: Fixes: website maintenance Problem: - converted f5-os-docs/index.html to md Analysis: Unit/Robot tests: Fixes: liquid templates Problem: Analysis: Unit/Robot tests: Fixes: add files for tocify Problem: - tocify is a jquery plugin that automatically builds a TOC Analysis: Unit/Robot tests: Fixes: add files for tocify Problem: - tocify is a jquery plugin that automatically builds a TOC Analysis: Unit/Robot tests: Fixes: modified max-width for docs_page toc side bar Fixes: modified max-width for docs_page toc side bar Revert "Fixes: modified max-width for docs_page toc side bar"; this commit was a rebase; I'm reverting it because it's causing a merge conflict upstream. This reverts commit bad90d6db7ee8a3c1cb8a361ae1cd58480bcba79. Travis CI and website configurations Update ci_pre-deploy.sh What I changed: I added the travis "$TRAVIS_REPO_SLUG" variable in place of the actual github repo name. Update .travis.yml What I changed: I changed `before_install` to `before_script` because the chmod doesn't need to occur before the dependencies are installed. I then placed the section after the env variables. Update ci_pre-deploy.sh What I changed: - I commented out the if / then statement for now (will test adding that back in once everything is building to my satisfaction) - I added a command to build the site to a new directory (./site_build) Update .travis.yml What I changed: - I replaced the hard-coded repo name with the travis_repo_slug variable. - I replaced the hard-coded branch name with the travis_branch variable. Update .travis.yml I forgot to use $ in the variable names in the last commit. Update cibuild.sh What I changed: - I removed the jekyll and htmlproof executables from the script (moving them to the .travis.yml file). - I added the content of ci_pre-deploy.sh here (will be deleting ci_pre-deploy bc travis will only run one script and I prefer to use this one). Delete ci_deploy.sh Delete ci_pre-deploy.sh Update .travis.yml Update cibuild.sh Added commands to build and proof back in. Update cibuild.sh What I changed: - commented out the html proofer for now, since a lot is broken in the template. Update .travis.yml What I changed: - added local directory 'site_build' as the directory from which to deploy to s3. Update README.md updated URL for travis build icon Update .travis.yml What I changed: - added travis variable for repo name in deploy section - added travis variable for branch in deploy section Fixes: No bug ID Problem: Travis build breaks bc GH_TOKEN isn't valid for the F5Networks repo. Analysis: I made travis its own github account, generated an access token, encrypted it, and added it to the .travis.yml file. Unit/Robot tests: Update cibuild.sh What I changed: -- replaced GH_TOKEN with GH_USER Update cibuild.sh What I changed: - replaced http clone url with SSH clone url Revert "Update cibuild.sh" This reverts commit e62c1908de7f76c265c2a55f6033ff5e0528b5ed. Revert "Update cibuild.sh" This reverts commit 302b21d445e5fe4ceb517a9441974d8f26901dcc. Revert "Fixes: No bug ID" This reverts commit 232ff82f307946a7500c61469f9fe9d6449c68c4. I fixed the conflict between F5Networks/master and jputrino/master. Fixes: travis builds fail on branch 'site' Problem: travis-ci is unable to build from branch 'site' because it doesn't have a .travis.yml file. Analysis: I added the 'site' branch to the travis blacklist so build will not be triggered when files are pushed to 'site'. Unit/Robot tests: Update .travis.yml What I changed: - Removed GH_TOKEN; replacing with variable GH_USER (which is configured in repos in travis-ci.com) in script. Fixes: Travis build 92 failed - could not install jekyll-pandoc Problem: Travis build #92 failed because it couldn't install the jekyll-pandoc gem. Analysis: I added jekyll-pandoc to the Gemfile. Unit/Robot tests: What I changed: - added a travis variable to the build script in the commit message that should prevent a new build on 'site' branch from kicking off a new build. - defined pygments as the jekyll highlighting tool What I changed: - started explaining the build and deployment process in the README for the f5-openstack-docs repo - made a minor edit to an 'echo' command in the build script What I changed: - entered encrypted env variables for github username and password in the build script so travis can build from the F5Networks repo. Fixes Issue #5 - Travis deployment to s3 is failing What I changed: - I added an encrypted env variable for the AWS Access key for travis-ci Fixes Issue #10 - Travis authentication issues Problem: Travis is unable to push content of site_build folder back to github repo bc authentication fails. Solution: Za and Jeff explained that as long as we have the framework for building the site in github, we don't need the actual site there, too. What I changed: - removed the commands from the cibuild.sh script that told travis to clone the repo and push to the site branch - removed the gh token section from .travis.yml - removed the 'blacklist' section from .travis.yml What I changed: added the command to copy the site build dir over to the local dir back in; the deploy section tells travis to deploy to s3 from $HOME/site_build Fixes: Pull request triggers travis build, but doesn't deploy to Amazon S3 Problem: I took out the command that copied the site build over to the home dir in travis. Analysis: I added the command back in in the previous commit; in this one, I corrected a typo that triggered an error. Unit/Robot tests: Fixes: JIRA - OPENSTACK-28: Docs Website Configuration Problem: We need a website to publicly host the OpenStack docs. Analysis: I made a website. - updated bootstrap template with some F5 Cloud Ready text and links - updated the README with some information about the ci build and deployment process Unit/Robot tests: Fixes: Use pandoc for markdown to html conversion. Problem: I need to use pandoc to convert markdown files to html files. Analysis: I added commands to the jekyll _config.yml file that tell it to use pandoc as the markdown converter. Unit/Robot tests: Fixes: edit _config.yml Problem: n/a Analysis: - change site title to F5 Cloud Ready Unit/Robot tests: Fixes: N/A -- .travis.yml config update Problem: Analysis: - added 'cache: bundler' to travis configs to speed up build - added branch whitelist - removed un-needed token Unit/Robot tests: Fixes: travis build #97 Problem: travis build failed due to an issue with jekyll Analysis: added pre-installation 'gem update' command to ensure latest versions of all gems are being used Unit/Robot tests: Fixes: N/A -- .TRAVIS/YML UPDATE Problem: Analysis: - added "--system" flag to 'gem update' to update the version of Ruby Gems, not the gems themselves (having issues with the latest v of jekyll, so don't want it updated) Unit/Robot tests: Fixes: travis build #98 failed Problem: jekyll could not build site Analysis: could be a ruby version issue; updated .travis.yml to install latest version of ruby gems Unit/Robot tests: Fixes: travis build #99n errored Problem: could not install ruby Analysis: changed to 'rvm: 2.2' Unit/Robot tests: Fixes: N/A -- jekyll build config update Problem: - I changed the markdown converter from jekyll-pandoc back to kramdown (the default) Analysis: Unit/Robot tests: Fixes: N/A -- .travis.yml config update Problem:build #101 'did not deploy to s3 provider because this branch is not permitted' Analysis: added '$TRAVISBRANCH' back to .travis.yml deploy section Unit/Robot tests: Fixes: N/A -- update .travis.yml Problem: Analysis: - change deploy 'acl' setting from 'private' to 'authenticated_read' Unit/Robot tests: Fixes: N/A -- updated index.html Problem: Analysis: Unit/Robot tests: Fixes: N/A -- added repo for 'homeless' docs Problem: - we need a place where all docs can be accessed (from across all sub-dirs) - we need a home for docs that don't clearly fit into any other repo Analysis: - added new _docs repo to house otherwise homeless docs - added index.html file to serve as docs index at a later date Unit/Robot tests: Fixes: changed name of S3 bucket to dev Problem: Analysis: Unit/Robot tests: Fixes: change name of AWS S3 bucket in .travis.yml Problem: Analysis: Unit/Robot tests: Fixes: website maintenance - added project folders using 'f5-*' naming convention - renamed existing project folder _docs to f5-os-docs - removed stock jekyll post from _posts folder - added versioning plugin gem to Gemfile and _config.yml - removed stock jekyll about page Problem: Analysis: Unit/Robot tests: Fixes: Travis build #108 broken: Liquid Exception: Variable '{{if node.fqdn in {'node-compute-1.maas'}' was not properly terminated with regexp: /\}\}/ in f5-os-docs/Demo-and-Testing-Tools-Guide.md Problem: text in a code block incorrectly interpreted as a liquid tag Analysis: added the '{%raw}' and '{%endraw}' tags Unit/Robot tests: Fixes: website configuration Problem: - added plugin to track versioning - added plugin to create project index page from the README in the github repo Analysis: Unit/Robot tests: Fixes: travis build #110 broken Problem: travis can't find dependencies for plugins Analysis: added install step to .travis.yml to bundle install the plugin gems Unit/Robot tests: Fixes: travis build #111 failed Problem: incorrect command usage (bundle install) Analysis: Unit/Robot tests: Fixes: travis build #112 failing Problem: incorrect command usage (bundle install ...) Analysis: Unit/Robot tests: Fixes: travis build #113 failing Problem: error in generate_projects.rb plugin Analysis: Unit/Robot tests: Fixes: travis build #114 failing Problem: cannot load required file in generate_projects.rb plugin Analysis: Unit/Robot tests: Fixes: travis build #115 failing Problem: generate_projects.rb load failing Analysis: Unit/Robot tests: Fixes: travis build #116 failed Problem: Analysis: Unit/Robot tests: Fixes: travis build #117 failing Problem: Analysis: Unit/Robot tests: Fixes: travis build #118 failing Problem: plugin unable to load dependencies - I moved the file out of the _plugins directory to be dealt with later Analysis: Unit/Robot tests: Fixes: travis build #119 failing Problem: Analysis: Unit/Robot tests: Fixes: travis build #119 failing Problem: Analysis: Unit/Robot tests: Fixes: travis build #121 failing Problem: Unable to install dependencies for the jekyll project pages plugin Analysis: I removed the dependencies from the config file and moved the plugins to a holding folder. Unit/Robot tests: Fixes: travis build #121 failing Problem: Liquid Exception: Tag '{%' was not properly terminated with regexp: /\%\}/ in f5-os-docs/Demo-and-Testing-Tools-Guide.md Analysis: - fixed liquid tags - removed 'index.html' (replaced with 'os_landingpage.html') Unit/Robot tests: Fixes: website maintenance Problem: - replaced 'index.html' with /os_landingpage.html' for password-protection on dev site - moved faulty plugins to 'plugins' folder Analysis: Unit/Robot tests: Fixes: travis build #123 failing Problem: travis unable to locate/access f5-openstack-dev bucket Analysis: - I added a new policy to the travis user in s3 that should allow it access to all buckets. Unit/Robot tests: Fixes: website configuration Problem: - templates for head, header, docs landing pages - add liquid tags to os_landingpage.html in place of the head and header Analysis: Unit/Robot tests: Fixes: website maintenance Problem: - configuring layout templates and landing pages Analysis: Unit/Robot tests: Fixes: Website maintenance Problem: Jekyll needs 'index.html' to build the site. We're using 'index.html' as the login page - stored in the s3 bucket for security purposes - so we need to change the name of the file in the build before deploying to the s3 dev bucket. Analysis: - edited the cibuild script to rename index.html to os_landingpage.html after copying files over to travis' home dir Unit/Robot tests: Fixes: website maintenance Problem: - added command to build script to remove the 'index.html' file after renaming it to 'os_landingpage.html' for dev builds Analysis: Unit/Robot tests: Fixes: travis build #126 failing Problem: command 'rm index.html' broke the build because the file wasn't found Analysis: - edited the script to look for the file first, then delete it if found Unit/Robot tests: Fixes: index isn't renamed before deploy to s3 from the develop branch Problem: The index.html file needs to be renamed to os_landingpage.html before the site is deployed to the dev bucket in s3 to ensure proper security. Analysis: - I edited the script to execute this command set earlier (before site build is copied to travis' home dir) Unit/Robot tests: Fixes: added frontmatter to f5-os-docs/* Problem: Analysis: Unit/Robot tests: Fixes: website maintenance Problem: - I added the site url to the config.yml file - I added a link to the f5-os-docs page to the nav bar on the home page - I created a list of the docs in the f5-os-docs folder on the f5-os-docs landing page Analysis: Unit/Robot tests: Fixes: removed section on renaming index file Problem: Analysis: Unit/Robot tests: Fixes: corrected link to f5-os-docs landing page Problem: Analysis: Unit/Robot tests: Fixes: website maintenance Problem: - converted f5-os-docs/index.html to md Analysis: Unit/Robot tests: Fixes: liquid templates Problem: Analysis: Unit/Robot tests: Fixes: add files for tocify Problem: - tocify is a jquery plugin that automatically builds a TOC Analysis: Unit/Robot tests: Fixes: add files for tocify Problem: - tocify is a jquery plugin that automatically builds a TOC Analysis: Unit/Robot tests: Fixes: modified max-width for docs_page toc side bar Fixes: modified max-width for docs_page toc side bar Revert "Fixes: modified max-width for docs_page toc side bar"; this commit was a rebase; I'm reverting it because it's causing a merge conflict upstream. This reverts commit bad90d6db7ee8a3c1cb8a361ae1cd58480bcba79. These commits configure the website. Fixes: add out-of-the-box bootstrap files; update frontmatter; update index.html Problem: Analysis: Unit/Robot tests: Fixes: website formatting Problem: Analysis: Unit/Robot tests: Fixes: website formatting Problem: Analysis: Unit/Robot tests: Fixes: website styling with F5 css Problem: Analysis: Unit/Robot tests: Fixes: add jekyll-pandoc-multiple-formats plugin to _plugins dir Problem: Analysis: Unit/Robot tests: Fixes: changes to _config.yml for jekyll-pandoc-multiple-formats Problem: Analysis: Unit/Robot tests: Fixes: travis build #139 failed Problem: Analysis: Unit/Robot tests: Fixes: travis build #140 failed Problem:"/home/travis/build/jputrino/f5-openstack-docs/_plugins/jekyll-pandoc-multiple-formats.rb:4:in `require': cannot load such file -- jekyll-pandoc-multiple-formats/version (LoadError)" Analysis: added '.rb' to jekyll-pandoc-multiple-formats/version Unit/Robot tests: Fixes: travis build #141 failed Problem: plugin dependencies won't load and break the build Analysis: - removed plugin dependencies (moved to 'plugins' folder to revisit later as needed) - modded the _config.yml file: added custom vars, the tocify gem, and switched back to kramdown Unit/Robot tests: Fixes: travis build #142 failed Problem: - added a comma between gems in _config.yml Analysis: Unit/Robot tests: Fixes: changed format for f5-os-docs/* Problem: Analysis: Unit/Robot tests: Fixes: edited '_includes' and '_layouts' files Problem: Analysis: Unit/Robot tests: Fixes: remove duplicate document Problem: - The OpenStack Deployment Tips document lived here and in f5-os-odk. Analysis: - I removed the doc from this repo. Unit/Robot tests: Fixes: website maintenance Problem: - added liquid tags to links for each s3 project folder Analysis: Unit/Robot tests: Fixes: simplify styling Problem: - cut out all style sheets except for main.scss - added f5 styling to _sass sheets Analysis: Unit/Robot tests: Fixes: header.html Problem: Analysis: Unit/Robot tests: Fixes: styling Problem: WIP -- editing index.html to use new Sass style sheets -- editing the sass stylesheets Analysis: Unit/Robot tests: Fixes: travis build #150 failed Problem: Liquid Exception: Unknown tag 'f5' in _includes/header.html, included in _layouts/docs_page.html Analysis: fixed tag Unit/Robot tests: Fixes: travis build #151 failed Problem: Liquid Exception: Tag '{% /f5-os-docs/index.html | prepend:site.url %}' was not properly terminated with regexp: /\%\}/ in _includes/header.html, included in _layouts/docs_page.html Analysis: corrected tag Unit/Robot tests: Fixes: travis build #152 failed Problem: Liquid Exception: Unknown tag 'current' in _includes/footer.html, included in _layouts/docs_page.html Analysis: fixed tag Unit/Robot tests: Fixes: index.html is not rendering correctly Problem: No yaml header Analysis: added yaml header to define layout and page title Unit/Robot tests: Fixes: home page lacks styles Problem: the liquid tags are not correctly formatted to pull in the head, header, and footer Analysis: I corrected the tags. Unit/Robot tests: Fixes: site configurations Problem: The pages are rendering without styles. Analysis: I made edits to the head, header, and index html files. Unit/Robot tests: Fixes: site configuration Problem: styles on website are not rendering Analysis: switched back to bootstrap.css Unit/Robot tests: Fixes: travis s3 config file contains the wrong region Problem: Analysis: I specified the region as 'us-west-2'. Unit/Robot tests: Fixes: website styles are not rendering Problem: the css/sass templates aren't being applied to the page Analysis: I switched back to f5-style.css and associated tags in head.html and header.html. Unit/Robot tests: Fixes: _includes/footer.html Problem: footer needs to be updated to remove unnecessary information Analysis: - I removed the giant github icon - I added the liquid tags to pull in the repo name and version number (these are stored as custom variables in the _config.yml file). Unit/Robot tests: Fixes: edited header.html -- switched back to f5-style tags Problem: Analysis: Unit/Robot tests: Fixes: edited head.html - changed reference to stylesheet to ' site.url/css/f5-styles.css' from 'css/f5-styles.css' Problem: Analysis: Unit/Robot tests: Fixes: removed extra '/' from reference to stylesheet Problem: Analysis: Unit/Robot tests: Fixes: edited head.html Problem: Analysis: diff --git a/_includes/head.html b/_includes/head.html index 840d300..efdcf4c 100644 --- a/_includes/head.html +++ b/_includes/head.html @@ -11,5 +11,5 @@ <link rel="canonical" href="{{ page.url | replace:'index.html','' | prepend: site.baseurl | prepend: site.url }}"> - <link rel="alternate" type="application/rss+xml" title="{{ site.title }}" href="{{ "/feed.xml" | prepend: site.baseurl | prepend: site.url }}" /> + <link rel="alternate" type="application/rss+xml" title="{{ site.title }}" href="{{ "feed.xml" | prepend: site.baseurl | prepend: site.url }}" /> </head> Unit/Robot tests: Fixes: edited index.html Problem: header was displaying twice Analysis: - Head and header were referenced in the template and in the page itself. I removed the reference to head and header from the page. Unit/Robot tests: Fixes: edited footer.html Problem: footer was hard-coded into index.html. Analysis: I moved the content into footer.html and edited for style and content. Unit/Robot tests: Fixes: edit index.html Problem: index.html contained the text for the footer and required style edits. Analysis: I removed the footer content and edited the doc for style. Unit/Robot tests: Fixes: added Font Awesome css and font files. Problem: Analysis: Unit/Robot tests: Fixes: added new background class to f5-styles.css (light gray) Problem: Analysis: Unit/Robot tests: Fixes: header not displaying inline Problem: header missing tag to display list items inline Analysis: added main-nav class to ul Unit/Robot tests: Fixes: nav bar blocks top of home page Problem: added css styling to (hopefully) pull content down Analysis: Unit/Robot tests: Fixes: modified head_for_docs.html and header.html Problem: - head_for_docs.html contained tags that were converting each page into a folder with an index.html file in it - header.html was missing liquid tag 'prepend: site.url' in css ref Analysis: - commented out code that was causing the problem in head_for_docs.html - added tag to header.html Unit/Robot tests: Fixes: the first container is overlapping with the header Problem: Analysis: - added new class to f5-style.css to increase the top margin for the first\ container Unit/Robot tests: Fixes: first container is overlapping with the header Problem: - I used the new class to increase the margin from the top of the page. Analysis: Unit/Robot tests: Fixes: testing out auto-generation of index page Problem: need a way to automatically generate a list of all documentation, organized by category Analysis: - added categories to _config.yml - added an index.html file with the liquid code to pull in the page list - added category tags and "resource: true" to the yaml header for the doc files Unit/Robot tests: Fixes: added 'misc_docs' to the categories list in _config.yml Problem: Analysis: Unit/Robot tests: Fixes: I need a way to automatically generate a docs index page. Problem: - I added categories from the master list in _config.yml to the header of each doc. Analysis: Unit/Robot tests: Fixes: modified css tags in the default layout Problem: Analysis: Unit/Robot tests: Fixes: Changed layout and added a few html tags Problem: Analysis: Unit/Robot tests: Fixes: edited _config.yml: added "baseurl: "f5-os-docs/" Problem: Analysis: Unit/Robot tests: Fixes: I need to set up the styles for the page templates. I'd like to use tocify to generate TOCs for the docs_page template. Problem: - I added a new page template -- home -- that has no styling (to use for home pages). - I added some styling to default. - I created a new layout with the tocify dependencies (css and scripts). - I added some styling and the tocify script to docs_page. Analysis: Unit/Robot tests: Fixes: This commit has the new homepage layout that contains no style tags. Problem: Analysis: Unit/Robot tests: Fixes: I changed the template for the home page to 'homepage'. I also updated the css a bit to make it look better. Problem: Analysis: Unit/Robot tests: Fixes: adding some font files Problem: Analysis: Unit/Robot tests: Fixes: TOC not automatically generated Problem: - I moved the script outside of the body. Analysis: Unit/Robot tests: Fixes: configurations for tocify Problem: I need to use tocify to generate a TOC sidebar automatically Analysis: - I added a new stylesheet. - I added a reference to the new stylesheet to head_for_docs.html. - I edited the docs_page layout. Unit/Robot tests: Fixes: I commented out the gems section from _config.yml and copied over the _lbaasconfig.yml file. Problem: Analysis: Unit/Robot tests: Fixes: corrected location of '_includes' dir in '_lbaasconfig.yml' Problem: Analysis: Unit/Robot tests: Fixes: moved /css, /fonts, /js, /media under new dir -- assets/ Problem: Analysis: Unit/Robot tests: Fixes: remove _lbaasconfig.yml Problem: Analysis: Unit/Robot tests: Travis CI and website configurations Update ci_pre-deploy.sh What I changed: I added the travis "$TRAVIS_REPO_SLUG" variable in place of the actual github repo name. Update .travis.yml What I changed: I changed `before_install` to `before_script` because the chmod doesn't need to occur before the dependencies are installed. I then placed the section after the env variables. Update ci_pre-deploy.sh What I changed: - I commented out the if / then statement for now (will test adding that back in once everything is building to my satisfaction) - I added a command to build the site to a new directory (./site_build) Update .travis.yml What I changed: - I replaced the hard-coded repo name with the travis_repo_slug variable. - I replaced the hard-coded branch name with the travis_branch variable. Update .travis.yml I forgot to use $ in the variable names in the last commit. Update cibuild.sh What I changed: - I removed the jekyll and htmlproof executables from the script (moving them to the .travis.yml file). - I added the content of ci_pre-deploy.sh here (will be deleting ci_pre-deploy bc travis will only run one script and I prefer to use this one). Delete ci_deploy.sh Delete ci_pre-deploy.sh Update .travis.yml Update cibuild.sh Added commands to build and proof back in. Update cibuild.sh What I changed: - commented out the html proofer for now, since a lot is broken in the template. Update .travis.yml What I changed: - added local directory 'site_build' as the directory from which to deploy to s3. Update README.md updated URL for travis build icon Update .travis.yml What I changed: - added travis variable for repo name in deploy section - added travis variable for branch in deploy section Fixes: No bug ID Problem: Travis build breaks bc GH_TOKEN isn't valid for the F5Networks repo. Analysis: I made travis its own github account, generated an access token, encrypted it, and added it to the .travis.yml file. Unit/Robot tests: Update cibuild.sh What I changed: -- replaced GH_TOKEN with GH_USER Update cibuild.sh What I changed: - replaced http clone url with SSH clone url Revert "Update cibuild.sh" This reverts commit e62c1908de7f76c265c2a55f6033ff5e0528b5ed. Revert "Update cibuild.sh" This reverts commit 302b21d445e5fe4ceb517a9441974d8f26901dcc. Revert "Fixes: No bug ID" This reverts commit 232ff82f307946a7500c61469f9fe9d6449c68c4. I fixed the conflict between F5Networks/master and jputrino/master. Fixes: travis builds fail on branch 'site' Problem: travis-ci is unable to build from branch 'site' because it doesn't have a .travis.yml file. Analysis: I added the 'site' branch to the travis blacklist so build will not be triggered when files are pushed to 'site'. Unit/Robot tests: Update .travis.yml What I changed: - Removed GH_TOKEN; replacing with variable GH_USER (which is configured in repos in travis-ci.com) in script. Fixes: Travis build 92 failed - could not install jekyll-pandoc Problem: Travis build #92 failed because it couldn't install the jekyll-pandoc gem. Analysis: I added jekyll-pandoc to the Gemfile. Unit/Robot tests: What I changed: - added a travis variable to the build script in the commit message that should prevent a new build on 'site' branch from kicking off a new build. - defined pygments as the jekyll highlighting tool What I changed: - started explaining the build and deployment process in the README for the f5-openstack-docs repo - made a minor edit to an 'echo' command in the build script What I changed: - entered encrypted env variables for github username and password in the build script so travis can build from the F5Networks repo. Fixes Issue #5 - Travis deployment to s3 is failing What I changed: - I added an encrypted env variable for the AWS Access key for travis-ci Fixes Issue #10 - Travis authentication issues Problem: Travis is unable to push content of site_build folder back to github repo bc authentication fails. Solution: Za and Jeff explained that as long as we have the framework for building the site in github, we don't need the actual site there, too. What I changed: - removed the commands from the cibuild.sh script that told travis to clone the repo and push to the site branch - removed the gh token section from .travis.yml - removed the 'blacklist' section from .travis.yml What I changed: added the command to copy the site build dir over to the local dir back in; the deploy section tells travis to deploy to s3 from $HOME/site_build Fixes: Pull request triggers travis build, but doesn't deploy to Amazon S3 Problem: I took out the command that copied the site build over to the home dir in travis. Analysis: I added the command back in in the previous commit; in this one, I corrected a typo that triggered an error. Unit/Robot tests: Fixes: JIRA - OPENSTACK-28: Docs Website Configuration Problem: We need a website to publicly host the OpenStack docs. Analysis: I made a website. - updated bootstrap template with some F5 Cloud Ready text and links - updated the README with some information about the ci build and deployment process Unit/Robot tests: Fixes: Use pandoc for markdown to html conversion. Problem: I need to use pandoc to convert markdown files to html files. Analysis: I added commands to the jekyll _config.yml file that tell it to use pandoc as the markdown converter. Unit/Robot tests: Fixes: edit _config.yml Problem: n/a Analysis: - change site title to F5 Cloud Ready Unit/Robot tests: Fixes: N/A -- .travis.yml config update Problem: Analysis: - added 'cache: bundler' to travis configs to speed up build - added branch whitelist - removed un-needed token Unit/Robot tests: Fixes: travis build #97 Problem: travis build failed due to an issue with jekyll Analysis: added pre-installation 'gem update' command to ensure latest versions of all gems are being used Unit/Robot tests: Fixes: N/A -- .TRAVIS/YML UPDATE Problem: Analysis: - added "--system" flag to 'gem update' to update the version of Ruby Gems, not the gems themselves (having issues with the latest v of jekyll, so don't want it updated) Unit/Robot tests: Fixes: travis build #98 failed Problem: jekyll could not build site Analysis: could be a ruby version issue; updated .travis.yml to install latest version of ruby gems Unit/Robot tests: Fixes: travis build #99n errored Problem: could not install ruby Analysis: changed to 'rvm: 2.2' Unit/Robot tests: Fixes: N/A -- jekyll build config update Problem: - I changed the markdown converter from jekyll-pandoc back to kramdown (the default) Analysis: Unit/Robot tests: Fixes: N/A -- .travis.yml config update Problem:build #101 'did not deploy to s3 provider because this branch is not permitted' Analysis: added '$TRAVISBRANCH' back to .travis.yml deploy section Unit/Robot tests: Fixes: N/A -- update .travis.yml Problem: Analysis: - change deploy 'acl' setting from 'private' to 'authenticated_read' Unit/Robot tests: Fixes: N/A -- updated index.html Problem: Analysis: Unit/Robot tests: Fixes: N/A -- added repo for 'homeless' docs Problem: - we need a place where all docs can be accessed (from across all sub-dirs) - we need a home for docs that don't clearly fit into any other repo Analysis: - added new _docs repo to house otherwise homeless docs - added index.html file to serve as docs index at a later date Unit/Robot tests: Fixes: changed name of S3 bucket to dev Problem: Analysis: Unit/Robot tests: Fixes: change name of AWS S3 bucket in .travis.yml Problem: Analysis: Unit/Robot tests: Fixes: website maintenance - added project folders using 'f5-*' naming convention - renamed existing project folder _docs to f5-os-docs - removed stock jekyll post from _posts folder - added versioning plugin gem to Gemfile and _config.yml - removed stock jekyll about page Problem: Analysis: Unit/Robot tests: Fixes: Travis build #108 broken: Liquid Exception: Variable '{{if node.fqdn in {'node-compute-1.maas'}' was not properly terminated with regexp: /\}\}/ in f5-os-docs/Demo-and-Testing-Tools-Guide.md Problem: text in a code block incorrectly interpreted as a liquid tag Analysis: added the '{%raw}' and '{%endraw}' tags Unit/Robot tests: Fixes: website configuration Problem: - added plugin to track versioning - added plugin to create project index page from the README in the github repo Analysis: Unit/Robot tests: Fixes: travis build #110 broken Problem: travis can't find dependencies for plugins Analysis: added install step to .travis.yml to bundle install the plugin gems Unit/Robot tests: Fixes: travis build #111 failed Problem: incorrect command usage (bundle install) Analysis: Unit/Robot tests: Fixes: travis build #112 failing Problem: incorrect command usage (bundle install ...) Analysis: Unit/Robot tests: Fixes: travis build #113 failing Problem: error in generate_projects.rb plugin Analysis: Unit/Robot tests: Fixes: travis build #114 failing Problem: cannot load required file in generate_projects.rb plugin Analysis: Unit/Robot tests: Fixes: travis build #115 failing Problem: generate_projects.rb load failing Analysis: Unit/Robot tests: Fixes: travis build #116 failed Problem: Analysis: Unit/Robot tests: Fixes: travis build #117 failing Problem: Analysis: Unit/Robot tests: Fixes: travis build #118 failing Problem: plugin unable to load dependencies - I moved the file out of the _plugins directory to be dealt with later Analysis: Unit/Robot tests: Fixes: travis build #119 failing Problem: Analysis: Unit/Robot tests: Fixes: travis build #119 failing Problem: Analysis: Unit/Robot tests: Fixes: travis build #121 failing Problem: Unable to install dependencies for the jekyll project pages plugin Analysis: I removed the dependencies from the config file and moved the plugins to a holding folder. Unit/Robot tests: Fixes: travis build #121 failing Problem: Liquid Exception: Tag '{%' was not properly terminated with regexp: /\%\}/ in f5-os-docs/Demo-and-Testing-Tools-Guide.md Analysis: - fixed liquid tags - removed 'index.html' (replaced with 'os_landingpage.html') Unit/Robot tests: Fixes: website maintenance Problem: - replaced 'index.html' with /os_landingpage.html' for password-protection on dev site - moved faulty plugins to 'plugins' folder Analysis: Unit/Robot tests: Fixes: travis build #123 failing Problem: travis unable to locate/access f5-openstack-dev bucket Analysis: - I added a new policy to the travis user in s3 that should allow it access to all buckets. Unit/Robot tests: Fixes: website configuration Problem: - templates for head, header, docs landing pages - add liquid tags to os_landingpage.html in place of the head and header Analysis: Unit/Robot tests: Fixes: website maintenance Problem: - configuring layout templates and landing pages Analysis: Unit/Robot tests: Fixes: Website maintenance Problem: Jekyll needs 'index.html' to build the site. We're using 'index.html' as the login page - stored in the s3 bucket for security purposes - so we need to change the name of the file in the build before deploying to the s3 dev bucket. Analysis: - edited the cibuild script to rename index.html to os_landingpage.html after copying files over to travis' home dir Unit/Robot tests: Fixes: website maintenance Problem: - added command to build script to remove the 'index.html' file after renaming it to 'os_landingpage.html' for dev builds Analysis: Unit/Robot tests: Fixes: travis build #126 failing Problem: command 'rm index.html' broke the build because the file wasn't found Analysis: - edited the script to look for the file first, then delete it if found Unit/Robot tests: Fixes: index isn't renamed before deploy to s3 from the develop branch Problem: The index.html file needs to be renamed to os_landingpage.html before the site is deployed to the dev bucket in s3 to ensure proper security. Analysis: - I edited the script to execute this command set earlier (before site build is copied to travis' home dir) Unit/Robot tests: Fixes: added frontmatter to f5-os-docs/* Problem: Analysis: Unit/Robot tests: Fixes: website maintenance Problem: - I added the site url to the config.yml file - I added a link to the f5-os-docs page to the nav bar on the home page - I created a list of the docs in the f5-os-docs folder on the f5-os-docs landing page Analysis: Unit/Robot tests: Fixes: removed section on renaming index file Problem: Analysis: Unit/Robot tests: Fixes: corrected link to f5-os-docs landing page Problem: Analysis: Unit/Robot tests: Fixes: website maintenance Problem: - converted f5-os-docs/index.html to md Analysis: Unit/Robot tests: Fixes: liquid templates Problem: Analysis: Unit/Robot tests: Fixes: add files for tocify Problem: - tocify is a jquery plugin that automatically builds a TOC Analysis: Unit/Robot tests: Fixes: add files for tocify Problem: - tocify is a jquery plugin that automatically builds a TOC Analysis: Unit/Robot tests: Fixes: modified max-width for docs_page toc side bar Fixes: modified max-width for docs_page toc side bar Revert "Fixes: modified max-width for docs_page toc side bar"; this commit was a rebase; I'm reverting it because it's causing a merge conflict upstream. This reverts commit bad90d6db7ee8a3c1cb8a361ae1cd58480bcba79. These commits configure the website. Fixes: add out-of-the-box bootstrap files; update frontmatter; update index.html Problem: Analysis: Unit/Robot tests: Fixes: website formatting Problem: Analysis: Unit/Robot tests: Fixes: website formatting Problem: Analysis: Unit/Robot tests: Fixes: website styling with F5 css Problem: Analysis: Unit/Robot tests: Fixes: add jekyll-pandoc-multiple-formats plugin to _plugins dir Problem: Analysis: Unit/Robot tests: Fixes: changes to _config.yml for jekyll-pandoc-multiple-formats Problem: Analysis: Unit/Robot tests: Fixes: travis build #139 failed Problem: Analysis: Unit/Robot tests: Fixes: travis build #140 failed Problem:"/home/travis/build/jputrino/f5-openstack-docs/_plugins/jekyll-pandoc-multiple-formats.rb:4:in `require': cannot load such file -- jekyll-pandoc-multiple-formats/version (LoadError)" Analysis: added '.rb' to jekyll-pandoc-multiple-formats/version Unit/Robot tests: Fixes: travis build #141 failed Problem: plugin dependencies won't load and break the build Analysis: - removed plugin dependencies (moved to 'plugins' folder to revisit later as needed) - modded the _config.yml file: added custom vars, the tocify gem, and switched back to kramdown Unit/Robot tests: Fixes: travis build #142 failed Problem: - added a comma between gems in…

Develop into jp-dev1 Travis CI and website configurations Update ci_pre-deploy.sh What I changed: I added the travis "$TRAVIS_REPO_SLUG" variable in place of the actual github repo name. Update .travis.yml What I changed: I changed `before_install` to `before_script` because the chmod doesn't need to occur before the dependencies are installed. I then placed the section after the env variables. Update ci_pre-deploy.sh What I changed: - I commented out the if / then statement for now (will test adding that back in once everything is building to my satisfaction) - I added a command to build the site to a new directory (./site_build) Update .travis.yml What I changed: - I replaced the hard-coded repo name with the travis_repo_slug variable. - I replaced the hard-coded branch name with the travis_branch variable. Update .travis.yml I forgot to use $ in the variable names in the last commit. Update cibuild.sh What I changed: - I removed the jekyll and htmlproof executables from the script (moving them to the .travis.yml file). - I added the content of ci_pre-deploy.sh here (will be deleting ci_pre-deploy bc travis will only run one script and I prefer to use this one). Delete ci_deploy.sh Delete ci_pre-deploy.sh Update .travis.yml Update cibuild.sh Added commands to build and proof back in. Update cibuild.sh What I changed: - commented out the html proofer for now, since a lot is broken in the template. Update .travis.yml What I changed: - added local directory 'site_build' as the directory from which to deploy to s3. Update README.md updated URL for travis build icon Update .travis.yml What I changed: - added travis variable for repo name in deploy section - added travis variable for branch in deploy section Fixes: No bug ID Problem: Travis build breaks bc GH_TOKEN isn't valid for the F5Networks repo. Analysis: I made travis its own github account, generated an access token, encrypted it, and added it to the .travis.yml file. Unit/Robot tests: Update cibuild.sh What I changed: -- replaced GH_TOKEN with GH_USER Update cibuild.sh What I changed: - replaced http clone url with SSH clone url Revert "Update cibuild.sh" This reverts commit e62c1908de7f76c265c2a55f6033ff5e0528b5ed. Revert "Update cibuild.sh" This reverts commit 302b21d445e5fe4ceb517a9441974d8f26901dcc. Travis CI and website configurations Update ci_pre-deploy.sh What I changed: I added the travis "$TRAVIS_REPO_SLUG" variable in place of the actual github repo name. Update .travis.yml What I changed: I changed `before_install` to `before_script` because the chmod doesn't need to occur before the dependencies are installed. I then placed the section after the env variables. Update ci_pre-deploy.sh What I changed: - I commented out the if / then statement for now (will test adding that back in once everything is building to my satisfaction) - I added a command to build the site to a new directory (./site_build) Update .travis.yml What I changed: - I replaced the hard-coded repo name with the travis_repo_slug variable. - I replaced the hard-coded branch name with the travis_branch variable. Update .travis.yml I forgot to use $ in the variable names in the last commit. Update cibuild.sh What I changed: - I removed the jekyll and htmlproof executables from the script (moving them to the .travis.yml file). - I added the content of ci_pre-deploy.sh here (will be deleting ci_pre-deploy bc travis will only run one script and I prefer to use this one). Delete ci_deploy.sh Delete ci_pre-deploy.sh Update .travis.yml Update cibuild.sh Added commands to build and proof back in. Update cibuild.sh What I changed: - commented out the html proofer for now, since a lot is broken in the template. Update .travis.yml What I changed: - added local directory 'site_build' as the directory from which to deploy to s3. Update README.md updated URL for travis build icon Update .travis.yml What I changed: - added travis variable for repo name in deploy section - added travis variable for branch in deploy section Fixes: No bug ID Problem: Travis build breaks bc GH_TOKEN isn't valid for the F5Networks repo. Analysis: I made travis its own github account, generated an access token, encrypted it, and added it to the .travis.yml file. Unit/Robot tests: Update cibuild.sh What I changed: -- replaced GH_TOKEN with GH_USER Update cibuild.sh What I changed: - replaced http clone url with SSH clone url Revert "Update cibuild.sh" This reverts commit e62c1908de7f76c265c2a55f6033ff5e0528b5ed. Revert "Update cibuild.sh" This reverts commit 302b21d445e5fe4ceb517a9441974d8f26901dcc. Revert "Fixes: No bug ID" This reverts commit 232ff82f307946a7500c61469f9fe9d6449c68c4. I fixed the conflict between F5Networks/master and jputrino/master. Fixes: travis builds fail on branch 'site' Problem: travis-ci is unable to build from branch 'site' because it doesn't have a .travis.yml file. Analysis: I added the 'site' branch to the travis blacklist so build will not be triggered when files are pushed to 'site'. Unit/Robot tests: Update .travis.yml What I changed: - Removed GH_TOKEN; replacing with variable GH_USER (which is configured in repos in travis-ci.com) in script. Fixes: Travis build 92 failed - could not install jekyll-pandoc Problem: Travis build #92 failed because it couldn't install the jekyll-pandoc gem. Analysis: I added jekyll-pandoc to the Gemfile. Unit/Robot tests: What I changed: - added a travis variable to the build script in the commit message that should prevent a new build on 'site' branch from kicking off a new build. - defined pygments as the jekyll highlighting tool What I changed: - started explaining the build and deployment process in the README for the f5-openstack-docs repo - made a minor edit to an 'echo' command in the build script What I changed: - entered encrypted env variables for github username and password in the build script so travis can build from the F5Networks repo. Fixes Issue #5 - Travis deployment to s3 is failing What I changed: - I added an encrypted env variable for the AWS Access key for travis-ci Fixes Issue #10 - Travis authentication issues Problem: Travis is unable to push content of site_build folder back to github repo bc authentication fails. Solution: Za and Jeff explained that as long as we have the framework for building the site in github, we don't need the actual site there, too. What I changed: - removed the commands from the cibuild.sh script that told travis to clone the repo and push to the site branch - removed the gh token section from .travis.yml - removed the 'blacklist' section from .travis.yml What I changed: added the command to copy the site build dir over to the local dir back in; the deploy section tells travis to deploy to s3 from $HOME/site_build Fixes: Pull request triggers travis build, but doesn't deploy to Amazon S3 Problem: I took out the command that copied the site build over to the home dir in travis. Analysis: I added the command back in in the previous commit; in this one, I corrected a typo that triggered an error. Unit/Robot tests: Fixes: JIRA - OPENSTACK-28: Docs Website Configuration Problem: We need a website to publicly host the OpenStack docs. Analysis: I made a website. - updated bootstrap template with some F5 Cloud Ready text and links - updated the README with some information about the ci build and deployment process Unit/Robot tests: Fixes: Use pandoc for markdown to html conversion. Problem: I need to use pandoc to convert markdown files to html files. Analysis: I added commands to the jekyll _config.yml file that tell it to use pandoc as the markdown converter. Unit/Robot tests: Fixes: edit _config.yml Problem: n/a Analysis: - change site title to F5 Cloud Ready Unit/Robot tests: Fixes: N/A -- .travis.yml config update Problem: Analysis: - added 'cache: bundler' to travis configs to speed up build - added branch whitelist - removed un-needed token Unit/Robot tests: Fixes: travis build #97 Problem: travis build failed due to an issue with jekyll Analysis: added pre-installation 'gem update' command to ensure latest versions of all gems are being used Unit/Robot tests: Fixes: N/A -- .TRAVIS/YML UPDATE Problem: Analysis: - added "--system" flag to 'gem update' to update the version of Ruby Gems, not the gems themselves (having issues with the latest v of jekyll, so don't want it updated) Unit/Robot tests: Fixes: travis build #98 failed Problem: jekyll could not build site Analysis: could be a ruby version issue; updated .travis.yml to install latest version of ruby gems Unit/Robot tests: Fixes: travis build #99n errored Problem: could not install ruby Analysis: changed to 'rvm: 2.2' Unit/Robot tests: Fixes: N/A -- jekyll build config update Problem: - I changed the markdown converter from jekyll-pandoc back to kramdown (the default) Analysis: Unit/Robot tests: Fixes: N/A -- .travis.yml config update Problem:build #101 'did not deploy to s3 provider because this branch is not permitted' Analysis: added '$TRAVISBRANCH' back to .travis.yml deploy section Unit/Robot tests: Fixes: N/A -- update .travis.yml Problem: Analysis: - change deploy 'acl' setting from 'private' to 'authenticated_read' Unit/Robot tests: Fixes: N/A -- updated index.html Problem: Analysis: Unit/Robot tests: Fixes: N/A -- added repo for 'homeless' docs Problem: - we need a place where all docs can be accessed (from across all sub-dirs) - we need a home for docs that don't clearly fit into any other repo Analysis: - added new _docs repo to house otherwise homeless docs - added index.html file to serve as docs index at a later date Unit/Robot tests: Fixes: changed name of S3 bucket to dev Problem: Analysis: Unit/Robot tests: Fixes: change name of AWS S3 bucket in .travis.yml Problem: Analysis: Unit/Robot tests: Fixes: website maintenance - added project folders using 'f5-*' naming convention - renamed existing project folder _docs to f5-os-docs - removed stock jekyll post from _posts folder - added versioning plugin gem to Gemfile and _config.yml - removed stock jekyll about page Problem: Analysis: Unit/Robot tests: Fixes: Travis build #108 broken: Liquid Exception: Variable '{{if node.fqdn in {'node-compute-1.maas'}' was not properly terminated with regexp: /\}\}/ in f5-os-docs/Demo-and-Testing-Tools-Guide.md Problem: text in a code block incorrectly interpreted as a liquid tag Analysis: added the '{%raw}' and '{%endraw}' tags Unit/Robot tests: Fixes: website configuration Problem: - added plugin to track versioning - added plugin to create project index page from the README in the github repo Analysis: Unit/Robot tests: Fixes: travis build #110 broken Problem: travis can't find dependencies for plugins Analysis: added install step to .travis.yml to bundle install the plugin gems Unit/Robot tests: Fixes: travis build #111 failed Problem: incorrect command usage (bundle install) Analysis: Unit/Robot tests: Fixes: travis build #112 failing Problem: incorrect command usage (bundle install ...) Analysis: Unit/Robot tests: Fixes: travis build #113 failing Problem: error in generate_projects.rb plugin Analysis: Unit/Robot tests: Fixes: travis build #114 failing Problem: cannot load required file in generate_projects.rb plugin Analysis: Unit/Robot tests: Fixes: travis build #115 failing Problem: generate_projects.rb load failing Analysis: Unit/Robot tests: Fixes: travis build #116 failed Problem: Analysis: Unit/Robot tests: Fixes: travis build #117 failing Problem: Analysis: Unit/Robot tests: Fixes: travis build #118 failing Problem: plugin unable to load dependencies - I moved the file out of the _plugins directory to be dealt with later Analysis: Unit/Robot tests: Fixes: travis build #119 failing Problem: Analysis: Unit/Robot tests: Fixes: travis build #119 failing Problem: Analysis: Unit/Robot tests: Fixes: travis build #121 failing Problem: Unable to install dependencies for the jekyll project pages plugin Analysis: I removed the dependencies from the config file and moved the plugins to a holding folder. Unit/Robot tests: Fixes: travis build #121 failing Problem: Liquid Exception: Tag '{%' was not properly terminated with regexp: /\%\}/ in f5-os-docs/Demo-and-Testing-Tools-Guide.md Analysis: - fixed liquid tags - removed 'index.html' (replaced with 'os_landingpage.html') Unit/Robot tests: Fixes: website maintenance Problem: - replaced 'index.html' with /os_landingpage.html' for password-protection on dev site - moved faulty plugins to 'plugins' folder Analysis: Unit/Robot tests: Fixes: travis build #123 failing Problem: travis unable to locate/access f5-openstack-dev bucket Analysis: - I added a new policy to the travis user in s3 that should allow it access to all buckets. Unit/Robot tests: Fixes: website configuration Problem: - templates for head, header, docs landing pages - add liquid tags to os_landingpage.html in place of the head and header Analysis: Unit/Robot tests: Fixes: website maintenance Problem: - configuring layout templates and landing pages Analysis: Unit/Robot tests: Fixes: Website maintenance Problem: Jekyll needs 'index.html' to build the site. We're using 'index.html' as the login page - stored in the s3 bucket for security purposes - so we need to change the name of the file in the build before deploying to the s3 dev bucket. Analysis: - edited the cibuild script to rename index.html to os_landingpage.html after copying files over to travis' home dir Unit/Robot tests: Fixes: website maintenance Problem: - added command to build script to remove the 'index.html' file after renaming it to 'os_landingpage.html' for dev builds Analysis: Unit/Robot tests: Fixes: travis build #126 failing Problem: command 'rm index.html' broke the build because the file wasn't found Analysis: - edited the script to look for the file first, then delete it if found Unit/Robot tests: Fixes: index isn't renamed before deploy to s3 from the develop branch Problem: The index.html file needs to be renamed to os_landingpage.html before the site is deployed to the dev bucket in s3 to ensure proper security. Analysis: - I edited the script to execute this command set earlier (before site build is copied to travis' home dir) Unit/Robot tests: Fixes: added frontmatter to f5-os-docs/* Problem: Analysis: Unit/Robot tests: Fixes: website maintenance Problem: - I added the site url to the config.yml file - I added a link to the f5-os-docs page to the nav bar on the home page - I created a list of the docs in the f5-os-docs folder on the f5-os-docs landing page Analysis: Unit/Robot tests: Fixes: removed section on renaming index file Problem: Analysis: Unit/Robot tests: Fixes: corrected link to f5-os-docs landing page Problem: Analysis: Unit/Robot tests: Fixes: website maintenance Problem: - converted f5-os-docs/index.html to md Analysis: Unit/Robot tests: Fixes: liquid templates Problem: Analysis: Unit/Robot tests: Fixes: add files for tocify Problem: - tocify is a jquery plugin that automatically builds a TOC Analysis: Unit/Robot tests: Fixes: add files for tocify Problem: - tocify is a jquery plugin that automatically builds a TOC Analysis: Unit/Robot tests: Fixes: modified max-width for docs_page toc side bar Fixes: modified max-width for docs_page toc side bar Travis CI and website configurations Update ci_pre-deploy.sh What I changed: I added the travis "$TRAVIS_REPO_SLUG" variable in place of the actual github repo name. Update .travis.yml What I changed: I changed `before_install` to `before_script` because the chmod doesn't need to occur before the dependencies are installed. I then placed the section after the env variables. Update ci_pre-deploy.sh What I changed: - I commented out the if / then statement for now (will test adding that back in once everything is building to my satisfaction) - I added a command to build the site to a new directory (./site_build) Update .travis.yml What I changed: - I replaced the hard-coded repo name with the travis_repo_slug variable. - I replaced the hard-coded branch name with the travis_branch variable. Update .travis.yml I forgot to use $ in the variable names in the last commit. Update cibuild.sh What I changed: - I removed the jekyll and htmlproof executables from the script (moving them to the .travis.yml file). - I added the content of ci_pre-deploy.sh here (will be deleting ci_pre-deploy bc travis will only run one script and I prefer to use this one). Delete ci_deploy.sh Delete ci_pre-deploy.sh Update .travis.yml Update cibuild.sh Added commands to build and proof back in. Update cibuild.sh What I changed: - commented out the html proofer for now, since a lot is broken in the template. Update .travis.yml What I changed: - added local directory 'site_build' as the directory from which to deploy to s3. Update README.md updated URL for travis build icon Update .travis.yml What I changed: - added travis variable for repo name in deploy section - added travis variable for branch in deploy section Fixes: No bug ID Problem: Travis build breaks bc GH_TOKEN isn't valid for the F5Networks repo. Analysis: I made travis its own github account, generated an access token, encrypted it, and added it to the .travis.yml file. Unit/Robot tests: Update cibuild.sh What I changed: -- replaced GH_TOKEN with GH_USER Update cibuild.sh What I changed: - replaced http clone url with SSH clone url Revert "Update cibuild.sh" This reverts commit e62c1908de7f76c265c2a55f6033ff5e0528b5ed. Revert "Update cibuild.sh" This reverts commit 302b21d445e5fe4ceb517a9441974d8f26901dcc. Revert "Fixes: No bug ID" This reverts commit 232ff82f307946a7500c61469f9fe9d6449c68c4. I fixed the conflict between F5Networks/master and jputrino/master. Fixes: travis builds fail on branch 'site' Problem: travis-ci is unable to build from branch 'site' because it doesn't have a .travis.yml file. Analysis: I added the 'site' branch to the travis blacklist so build will not be triggered when files are pushed to 'site'. Unit/Robot tests: Update .travis.yml What I changed: - Removed GH_TOKEN; replacing with variable GH_USER (which is configured in repos in travis-ci.com) in script. Fixes: Travis build 92 failed - could not install jekyll-pandoc Problem: Travis build #92 failed because it couldn't install the jekyll-pandoc gem. Analysis: I added jekyll-pandoc to the Gemfile. Unit/Robot tests: What I changed: - added a travis variable to the build script in the commit message that should prevent a new build on 'site' branch from kicking off a new build. - defined pygments as the jekyll highlighting tool What I changed: - started explaining the build and deployment process in the README for the f5-openstack-docs repo - made a minor edit to an 'echo' command in the build script What I changed: - entered encrypted env variables for github username and password in the build script so travis can build from the F5Networks repo. Fixes Issue #5 - Travis deployment to s3 is failing What I changed: - I added an encrypted env variable for the AWS Access key for travis-ci Fixes Issue #10 - Travis authentication issues Problem: Travis is unable to push content of site_build folder back to github repo bc authentication fails. Solution: Za and Jeff explained that as long as we have the framework for building the site in github, we don't need the actual site there, too. What I changed: - removed the commands from the cibuild.sh script that told travis to clone the repo and push to the site branch - removed the gh token section from .travis.yml - removed the 'blacklist' section from .travis.yml What I changed: added the command to copy the site build dir over to the local dir back in; the deploy section tells travis to deploy to s3 from $HOME/site_build Fixes: Pull request triggers travis build, but doesn't deploy to Amazon S3 Problem: I took out the command that copied the site build over to the home dir in travis. Analysis: I added the command back in in the previous commit; in this one, I corrected a typo that triggered an error. Unit/Robot tests: Fixes: JIRA - OPENSTACK-28: Docs Website Configuration Problem: We need a website to publicly host the OpenStack docs. Analysis: I made a website. - updated bootstrap template with some F5 Cloud Ready text and links - updated the README with some information about the ci build and deployment process Unit/Robot tests: Fixes: Use pandoc for markdown to html conversion. Problem: I need to use pandoc to convert markdown files to html files. Analysis: I added commands to the jekyll _config.yml file that tell it to use pandoc as the markdown converter. Unit/Robot tests: Fixes: edit _config.yml Problem: n/a Analysis: - change site title to F5 Cloud Ready Unit/Robot tests: Fixes: N/A -- .travis.yml config update Problem: Analysis: - added 'cache: bundler' to travis configs to speed up build - added branch whitelist - removed un-needed token Unit/Robot tests: Fixes: travis build #97 Problem: travis build failed due to an issue with jekyll Analysis: added pre-installation 'gem update' command to ensure latest versions of all gems are being used Unit/Robot tests: Fixes: N/A -- .TRAVIS/YML UPDATE Problem: Analysis: - added "--system" flag to 'gem update' to update the version of Ruby Gems, not the gems themselves (having issues with the latest v of jekyll, so don't want it updated) Unit/Robot tests: Fixes: travis build #98 failed Problem: jekyll could not build site Analysis: could be a ruby version issue; updated .travis.yml to install latest version of ruby gems Unit/Robot tests: Fixes: travis build #99n errored Problem: could not install ruby Analysis: changed to 'rvm: 2.2' Unit/Robot tests: Fixes: N/A -- jekyll build config update Problem: - I changed the markdown converter from jekyll-pandoc back to kramdown (the default) Analysis: Unit/Robot tests: Fixes: N/A -- .travis.yml config update Problem:build #101 'did not deploy to s3 provider because this branch is not permitted' Analysis: added '$TRAVISBRANCH' back to .travis.yml deploy section Unit/Robot tests: Fixes: N/A -- update .travis.yml Problem: Analysis: - change deploy 'acl' setting from 'private' to 'authenticated_read' Unit/Robot tests: Fixes: N/A -- updated index.html Problem: Analysis: Unit/Robot tests: Fixes: N/A -- added repo for 'homeless' docs Problem: - we need a place where all docs can be accessed (from across all sub-dirs) - we need a home for docs that don't clearly fit into any other repo Analysis: - added new _docs repo to house otherwise homeless docs - added index.html file to serve as docs index at a later date Unit/Robot tests: Fixes: changed name of S3 bucket to dev Problem: Analysis: Unit/Robot tests: Fixes: change name of AWS S3 bucket in .travis.yml Problem: Analysis: Unit/Robot tests: Fixes: website maintenance - added project folders using 'f5-*' naming convention - renamed existing project folder _docs to f5-os-docs - removed stock jekyll post from _posts folder - added versioning plugin gem to Gemfile and _config.yml - removed stock jekyll about page Problem: Analysis: Unit/Robot tests: Fixes: Travis build #108 broken: Liquid Exception: Variable '{{if node.fqdn in {'node-compute-1.maas'}' was not properly terminated with regexp: /\}\}/ in f5-os-docs/Demo-and-Testing-Tools-Guide.md Problem: text in a code block incorrectly interpreted as a liquid tag Analysis: added the '{%raw}' and '{%endraw}' tags Unit/Robot tests: Fixes: website configuration Problem: - added plugin to track versioning - added plugin to create project index page from the README in the github repo Analysis: Unit/Robot tests: Fixes: travis build #110 broken Problem: travis can't find dependencies for plugins Analysis: added install step to .travis.yml to bundle install the plugin gems Unit/Robot tests: Fixes: travis build #111 failed Problem: incorrect command usage (bundle install) Analysis: Unit/Robot tests: Fixes: travis build #112 failing Problem: incorrect command usage (bundle install ...) Analysis: Unit/Robot tests: Fixes: travis build #113 failing Problem: error in generate_projects.rb plugin Analysis: Unit/Robot tests: Fixes: travis build #114 failing Problem: cannot load required file in generate_projects.rb plugin Analysis: Unit/Robot tests: Fixes: travis build #115 failing Problem: generate_projects.rb load failing Analysis: Unit/Robot tests: Fixes: travis build #116 failed Problem: Analysis: Unit/Robot tests: Fixes: travis build #117 failing Problem: Analysis: Unit/Robot tests: Fixes: travis build #118 failing Problem: plugin unable to load dependencies - I moved the file out of the _plugins directory to be dealt with later Analysis: Unit/Robot tests: Fixes: travis build #119 failing Problem: Analysis: Unit/Robot tests: Fixes: travis build #119 failing Problem: Analysis: Unit/Robot tests: Fixes: travis build #121 failing Problem: Unable to install dependencies for the jekyll project pages plugin Analysis: I removed the dependencies from the config file and moved the plugins to a holding folder. Unit/Robot tests: Fixes: travis build #121 failing Problem: Liquid Exception: Tag '{%' was not properly terminated with regexp: /\%\}/ in f5-os-docs/Demo-and-Testing-Tools-Guide.md Analysis: - fixed liquid tags - removed 'index.html' (replaced with 'os_landingpage.html') Unit/Robot tests: Fixes: website maintenance Problem: - replaced 'index.html' with /os_landingpage.html' for password-protection on dev site - moved faulty plugins to 'plugins' folder Analysis: Unit/Robot tests: Fixes: travis build #123 failing Problem: travis unable to locate/access f5-openstack-dev bucket Analysis: - I added a new policy to the travis user in s3 that should allow it access to all buckets. Unit/Robot tests: Fixes: website configuration Problem: - templates for head, header, docs landing pages - add liquid tags to os_landingpage.html in place of the head and header Analysis: Unit/Robot tests: Fixes: website maintenance Problem: - configuring layout templates and landing pages Analysis: Unit/Robot tests: Fixes: Website maintenance Problem: Jekyll needs 'index.html' to build the site. We're using 'index.html' as the login page - stored in the s3 bucket for security purposes - so we need to change the name of the file in the build before deploying to the s3 dev bucket. Analysis: - edited the cibuild script to rename index.html to os_landingpage.html after copying files over to travis' home dir Unit/Robot tests: Fixes: website maintenance Problem: - added command to build script to remove the 'index.html' file after renaming it to 'os_landingpage.html' for dev builds Analysis: Unit/Robot tests: Fixes: travis build #126 failing Problem: command 'rm index.html' broke the build because the file wasn't found Analysis: - edited the script to look for the file first, then delete it if found Unit/Robot tests: Fixes: index isn't renamed before deploy to s3 from the develop branch Problem: The index.html file needs to be renamed to os_landingpage.html before the site is deployed to the dev bucket in s3 to ensure proper security. Analysis: - I edited the script to execute this command set earlier (before site build is copied to travis' home dir) Unit/Robot tests: Fixes: added frontmatter to f5-os-docs/* Problem: Analysis: Unit/Robot tests: Fixes: website maintenance Problem: - I added the site url to the config.yml file - I added a link to the f5-os-docs page to the nav bar on the home page - I created a list of the docs in the f5-os-docs folder on the f5-os-docs landing page Analysis: Unit/Robot tests: Fixes: removed section on renaming index file Problem: Analysis: Unit/Robot tests: Fixes: corrected link to f5-os-docs landing page Problem: Analysis: Unit/Robot tests: Fixes: website maintenance Problem: - converted f5-os-docs/index.html to md Analysis: Unit/Robot tests: Fixes: liquid templates Problem: Analysis: Unit/Robot tests: Fixes: add files for tocify Problem: - tocify is a jquery plugin that automatically builds a TOC Analysis: Unit/Robot tests: Fixes: add files for tocify Problem: - tocify is a jquery plugin that automatically builds a TOC Analysis: Unit/Robot tests: Fixes: modified max-width for docs_page toc side bar Fixes: modified max-width for docs_page toc side bar Revert "Fixes: modified max-width for docs_page toc side bar"; this commit was a rebase; I'm reverting it because it's causing a merge conflict upstream. This reverts commit bad90d6db7ee8a3c1cb8a361ae1cd58480bcba79. Travis CI and website configurations Update ci_pre-deploy.sh What I changed: I added the travis "$TRAVIS_REPO_SLUG" variable in place of the actual github repo name. Update .travis.yml What I changed: I changed `before_install` to `before_script` because the chmod doesn't need to occur before the dependencies are installed. I then placed the section after the env variables. Update ci_pre-deploy.sh What I changed: - I commented out the if / then statement for now (will test adding that back in once everything is building to my satisfaction) - I added a command to build the site to a new directory (./site_build) Update .travis.yml What I changed: - I replaced the hard-coded repo name with the travis_repo_slug variable. - I replaced the hard-coded branch name with the travis_branch variable. Update .travis.yml I forgot to use $ in the variable names in the last commit. Update cibuild.sh What I changed: - I removed the jekyll and htmlproof executables from the script (moving them to the .travis.yml file). - I added the content of ci_pre-deploy.sh here (will be deleting ci_pre-deploy bc travis will only run one script and I prefer to use this one). Delete ci_deploy.sh Delete ci_pre-deploy.sh Update .travis.yml Update cibuild.sh Added commands to build and proof back in. Update cibuild.sh What I changed: - commented out the html proofer for now, since a lot is broken in the template. Update .travis.yml What I changed: - added local directory 'site_build' as the directory from which to deploy to s3. Update README.md updated URL for travis build icon Update .travis.yml What I changed: - added travis variable for repo name in deploy section - added travis variable for branch in deploy section Fixes: No bug ID Problem: Travis build breaks bc GH_TOKEN isn't valid for the F5Networks repo. Analysis: I made travis its own github account, generated an access token, encrypted it, and added it to the .travis.yml file. Unit/Robot tests: Update cibuild.sh What I changed: -- replaced GH_TOKEN with GH_USER Update cibuild.sh What I changed: - replaced http clone url with SSH clone url Revert "Update cibuild.sh" This reverts commit e62c1908de7f76c265c2a55f6033ff5e0528b5ed. Revert "Update cibuild.sh" This reverts commit 302b21d445e5fe4ceb517a9441974d8f26901dcc. Revert "Fixes: No bug ID" This reverts commit 232ff82f307946a7500c61469f9fe9d6449c68c4. I fixed the conflict between F5Networks/master and jputrino/master. Fixes: travis builds fail on branch 'site' Problem: travis-ci is unable to build from branch 'site' because it doesn't have a .travis.yml file. Analysis: I added the 'site' branch to the travis blacklist so build will not be triggered when files are pushed to 'site'. Unit/Robot tests: Update .travis.yml What I changed: - Removed GH_TOKEN; replacing with variable GH_USER (which is configured in repos in travis-ci.com) in script. Fixes: Travis build 92 failed - could not install jekyll-pandoc Problem: Travis build #92 failed because it couldn't install the jekyll-pandoc gem. Analysis: I added jekyll-pandoc to the Gemfile. Unit/Robot tests: What I changed: - added a travis variable to the build script in the commit message that should prevent a new build on 'site' branch from kicking off a new build. - defined pygments as the jekyll highlighting tool What I changed: - started explaining the build and deployment process in the README for the f5-openstack-docs repo - made a minor edit to an 'echo' command in the build script What I changed: - entered encrypted env variables for github username and password in the build script so travis can build from the F5Networks repo. Fixes Issue #5 - Travis deployment to s3 is failing What I changed: - I added an encrypted env variable for the AWS Access key for travis-ci Fixes Issue #10 - Travis authentication issues Problem: Travis is unable to push content of site_build folder back to github repo bc authentication fails. Solution: Za and Jeff explained that as long as we have the framework for building the site in github, we don't need the actual site there, too. What I changed: - removed the commands from the cibuild.sh script that told travis to clone the repo and push to the site branch - removed the gh token section from .travis.yml - removed the 'blacklist' section from .travis.yml What I changed: added the command to copy the site build dir over to the local dir back in; the deploy section tells travis to deploy to s3 from $HOME/site_build Fixes: Pull request triggers travis build, but doesn't deploy to Amazon S3 Problem: I took out the command that copied the site build over to the home dir in travis. Analysis: I added the command back in in the previous commit; in this one, I corrected a typo that triggered an error. Unit/Robot tests: Fixes: JIRA - OPENSTACK-28: Docs Website Configuration Problem: We need a website to publicly host the OpenStack docs. Analysis: I made a website. - updated bootstrap template with some F5 Cloud Ready text and links - updated the README with some information about the ci build and deployment process Unit/Robot tests: Fixes: Use pandoc for markdown to html conversion. Problem: I need to use pandoc to convert markdown files to html files. Analysis: I added commands to the jekyll _config.yml file that tell it to use pandoc as the markdown converter. Unit/Robot tests: Fixes: edit _config.yml Problem: n/a Analysis: - change site title to F5 Cloud Ready Unit/Robot tests: Fixes: N/A -- .travis.yml config update Problem: Analysis: - added 'cache: bundler' to travis configs to speed up build - added branch whitelist - removed un-needed token Unit/Robot tests: Fixes: travis build #97 Problem: travis build failed due to an issue with jekyll Analysis: added pre-installation 'gem update' command to ensure latest versions of all gems are being used Unit/Robot tests: Fixes: N/A -- .TRAVIS/YML UPDATE Problem: Analysis: - added "--system" flag to 'gem update' to update the version of Ruby Gems, not the gems themselves (having issues with the latest v of jekyll, so don't want it updated) Unit/Robot tests: Fixes: travis build #98 failed Problem: jekyll could not build site Analysis: could be a ruby version issue; updated .travis.yml to install latest version of ruby gems Unit/Robot tests: Fixes: travis build #99n errored Problem: could not install ruby Analysis: changed to 'rvm: 2.2' Unit/Robot tests: Fixes: N/A -- jekyll build config update Problem: - I changed the markdown converter from jekyll-pandoc back to kramdown (the default) Analysis: Unit/Robot tests: Fixes: N/A -- .travis.yml config update Problem:build #101 'did not deploy to s3 provider because this branch is not permitted' Analysis: added '$TRAVISBRANCH' back to .travis.yml deploy section Unit/Robot tests: Fixes: N/A -- update .travis.yml Problem: Analysis: - change deploy 'acl' setting from 'private' to 'authenticated_read' Unit/Robot tests: Fixes: N/A -- updated index.html Problem: Analysis: Unit/Robot tests: Fixes: N/A -- added repo for 'homeless' docs Problem: - we need a place where all docs can be accessed (from across all sub-dirs) - we need a home for docs that don't clearly fit into any other repo Analysis: - added new _docs repo to house otherwise homeless docs - added index.html file to serve as docs index at a later date Unit/Robot tests: Fixes: changed name of S3 bucket to dev Problem: Analysis: Unit/Robot tests: Fixes: change name of AWS S3 bucket in .travis.yml Problem: Analysis: Unit/Robot tests: Fixes: website maintenance - added project folders using 'f5-*' naming convention - renamed existing project folder _docs to f5-os-docs - removed stock jekyll post from _posts folder - added versioning plugin gem to Gemfile and _config.yml - removed stock jekyll about page Problem: Analysis: Unit/Robot tests: Fixes: Travis build #108 broken: Liquid Exception: Variable '{{if node.fqdn in {'node-compute-1.maas'}' was not properly terminated with regexp: /\}\}/ in f5-os-docs/Demo-and-Testing-Tools-Guide.md Problem: text in a code block incorrectly interpreted as a liquid tag Analysis: added the '{%raw}' and '{%endraw}' tags Unit/Robot tests: Fixes: website configuration Problem: - added plugin to track versioning - added plugin to create project index page from the README in the github repo Analysis: Unit/Robot tests: Fixes: travis build #110 broken Problem: travis can't find dependencies for plugins Analysis: added install step to .travis.yml to bundle install the plugin gems Unit/Robot tests: Fixes: travis build #111 failed Problem: incorrect command usage (bundle install) Analysis: Unit/Robot tests: Fixes: travis build #112 failing Problem: incorrect command usage (bundle install ...) Analysis: Unit/Robot tests: Fixes: travis build #113 failing Problem: error in generate_projects.rb plugin Analysis: Unit/Robot tests: Fixes: travis build #114 failing Problem: cannot load required file in generate_projects.rb plugin Analysis: Unit/Robot tests: Fixes: travis build #115 failing Problem: generate_projects.rb load failing Analysis: Unit/Robot tests: Fixes: travis build #116 failed Problem: Analysis: Unit/Robot tests: Fixes: travis build #117 failing Problem: Analysis: Unit/Robot tests: Fixes: travis build #118 failing Problem: plugin unable to load dependencies - I moved the file out of the _plugins directory to be dealt with later Analysis: Unit/Robot tests: Fixes: travis build #119 failing Problem: Analysis: Unit/Robot tests: Fixes: travis build #119 failing Problem: Analysis: Unit/Robot tests: Fixes: travis build #121 failing Problem: Unable to install dependencies for the jekyll project pages plugin Analysis: I removed the dependencies from the config file and moved the plugins to a holding folder. Unit/Robot tests: Fixes: travis build #121 failing Problem: Liquid Exception: Tag '{%' was not properly terminated with regexp: /\%\}/ in f5-os-docs/Demo-and-Testing-Tools-Guide.md Analysis: - fixed liquid tags - removed 'index.html' (replaced with 'os_landingpage.html') Unit/Robot tests: Fixes: website maintenance Problem: - replaced 'index.html' with /os_landingpage.html' for password-protection on dev site - moved faulty plugins to 'plugins' folder Analysis: Unit/Robot tests: Fixes: travis build #123 failing Problem: travis unable to locate/access f5-openstack-dev bucket Analysis: - I added a new policy to the travis user in s3 that should allow it access to all buckets. Unit/Robot tests: Fixes: website configuration Problem: - templates for head, header, docs landing pages - add liquid tags to os_landingpage.html in place of the head and header Analysis: Unit/Robot tests: Fixes: website maintenance Problem: - configuring layout templates and landing pages Analysis: Unit/Robot tests: Fixes: Website maintenance Problem: Jekyll needs 'index.html' to build the site. We're using 'index.html' as the login page - stored in the s3 bucket for security purposes - so we need to change the name of the file in the build before deploying to the s3 dev bucket. Analysis: - edited the cibuild script to rename index.html to os_landingpage.html after copying files over to travis' home dir Unit/Robot tests: Fixes: website maintenance Problem: - added command to build script to remove the 'index.html' file after renaming it to 'os_landingpage.html' for dev builds Analysis: Unit/Robot tests: Fixes: travis build #126 failing Problem: command 'rm index.html' broke the build because the file wasn't found Analysis: - edited the script to look for the file first, then delete it if found Unit/Robot tests: Fixes: index isn't renamed before deploy to s3 from the develop branch Problem: The index.html file needs to be renamed to os_landingpage.html before the site is deployed to the dev bucket in s3 to ensure proper security. Analysis: - I edited the script to execute this command set earlier (before site build is copied to travis' home dir) Unit/Robot tests: Fixes: added frontmatter to f5-os-docs/* Problem: Analysis: Unit/Robot tests: Fixes: website maintenance Problem: - I added the site url to the config.yml file - I added a link to the f5-os-docs page to the nav bar on the home page - I created a list of the docs in the f5-os-docs folder on the f5-os-docs landing page Analysis: Unit/Robot tests: Fixes: removed section on renaming index file Problem: Analysis: Unit/Robot tests: Fixes: corrected link to f5-os-docs landing page Problem: Analysis: Unit/Robot tests: Fixes: website maintenance Problem: - converted f5-os-docs/index.html to md Analysis: Unit/Robot tests: Fixes: liquid templates Problem: Analysis: Unit/Robot tests: Fixes: add files for tocify Problem: - tocify is a jquery plugin that automatically builds a TOC Analysis: Unit/Robot tests: Fixes: add files for tocify Problem: - tocify is a jquery plugin that automatically builds a TOC Analysis: Unit/Robot tests: Fixes: modified max-width for docs_page toc side bar Fixes: modified max-width for docs_page toc side bar Revert "Fixes: modified max-width for docs_page toc side bar"; this commit was a rebase; I'm reverting it because it's causing a merge conflict upstream. This reverts commit bad90d6db7ee8a3c1cb8a361ae1cd58480bcba79. These commits configure the website. Fixes: add out-of-the-box bootstrap files; update frontmatter; update index.html Problem: Analysis: Unit/Robot tests: Fixes: website formatting Problem: Analysis: Unit/Robot tests: Fixes: website formatting Problem: Analysis: Unit/Robot tests: Fixes: website styling with F5 css Problem: Analysis: Unit/Robot tests: Fixes: add jekyll-pandoc-multiple-formats plugin to _plugins dir Problem: Analysis: Unit/Robot tests: Fixes: changes to _config.yml for jekyll-pandoc-multiple-formats Problem: Analysis: Unit/Robot tests: Fixes: travis build #139 failed Problem: Analysis: Unit/Robot tests: Fixes: travis build #140 failed Problem:"/home/travis/build/jputrino/f5-openstack-docs/_plugins/jekyll-pandoc-multiple-formats.rb:4:in `require': cannot load such file -- jekyll-pandoc-multiple-formats/version (LoadError)" Analysis: added '.rb' to jekyll-pandoc-multiple-formats/version Unit/Robot tests: Fixes: travis build #141 failed Problem: plugin dependencies won't load and break the build Analysis: - removed plugin dependencies (moved to 'plugins' folder to revisit later as needed) - modded the _config.yml file: added custom vars, the tocify gem, and switched back to kramdown Unit/Robot tests: Fixes: travis build #142 failed Problem: - added a comma between gems in _config.yml Analysis: Unit/Robot tests: Fixes: changed format for f5-os-docs/* Problem: Analysis: Unit/Robot tests: Fixes: edited '_includes' and '_layouts' files Problem: Analysis: Unit/Robot tests: Fixes: remove duplicate document Problem: - The OpenStack Deployment Tips document lived here and in f5-os-odk. Analysis: - I removed the doc from this repo. Unit/Robot tests: Fixes: website maintenance Problem: - added liquid tags to links for each s3 project folder Analysis: Unit/Robot tests: Fixes: simplify styling Problem: - cut out all style sheets except for main.scss - added f5 styling to _sass sheets Analysis: Unit/Robot tests: Fixes: header.html Problem: Analysis: Unit/Robot tests: Fixes: styling Problem: WIP -- editing index.html to use new Sass style sheets -- editing the sass stylesheets Analysis: Unit/Robot tests: Fixes: travis build #150 failed Problem: Liquid Exception: Unknown tag 'f5' in _includes/header.html, included in _layouts/docs_page.html Analysis: fixed tag Unit/Robot tests: Fixes: travis build #151 failed Problem: Liquid Exception: Tag '{% /f5-os-docs/index.html | prepend:site.url %}' was not properly terminated with regexp: /\%\}/ in _includes/header.html, included in _layouts/docs_page.html Analysis: corrected tag Unit/Robot tests: Fixes: travis build #152 failed Problem: Liquid Exception: Unknown tag 'current' in _includes/footer.html, included in _layouts/docs_page.html Analysis: fixed tag Unit/Robot tests: Fixes: index.html is not rendering correctly Problem: No yaml header Analysis: added yaml header to define layout and page title Unit/Robot tests: Fixes: home page lacks styles Problem: the liquid tags are not correctly formatted to pull in the head, header, and footer Analysis: I corrected the tags. Unit/Robot tests: Fixes: site configurations Problem: The pages are rendering without styles. Analysis: I made edits to the head, header, and index html files. Unit/Robot tests: Fixes: site configuration Problem: styles on website are not rendering Analysis: switched back to bootstrap.css Unit/Robot tests: Fixes: travis s3 config file contains the wrong region Problem: Analysis: I specified the region as 'us-west-2'. Unit/Robot tests: Fixes: website styles are not rendering Problem: the css/sass templates aren't being applied to the page Analysis: I switched back to f5-style.css and associated tags in head.html and header.html. Unit/Robot tests: Fixes: _includes/footer.html Problem: footer needs to be updated to remove unnecessary information Analysis: - I removed the giant github icon - I added the liquid tags to pull in the repo name and version number (these are stored as custom variables in the _config.yml file). Unit/Robot tests: Fixes: edited header.html -- switched back to f5-style tags Problem: Analysis: Unit/Robot tests: Fixes: edited head.html - changed reference to stylesheet to ' site.url/css/f5-styles.css' from 'css/f5-styles.css' Problem: Analysis: Unit/Robot tests: Fixes: removed extra '/' from reference to stylesheet Problem: Analysis: Unit/Robot tests: Fixes: edited head.html Problem: Analysis: diff --git a/_includes/head.html b/_includes/head.html index 840d300..efdcf4c 100644 --- a/_includes/head.html +++ b/_includes/head.html @@ -11,5 +11,5 @@ <link rel="canonical" href="{{ page.url | replace:'index.html','' | prepend: site.baseurl | prepend: site.url }}"> - <link rel="alternate" type="application/rss+xml" title="{{ site.title }}" href="{{ "/feed.xml" | prepend: site.baseurl | prepend: site.url }}" /> + <link rel="alternate" type="application/rss+xml" title="{{ site.title }}" href="{{ "feed.xml" | prepend: site.baseurl | prepend: site.url }}" /> </head> Unit/Robot tests: Fixes: edited index.html Problem: header was displaying twice Analysis: - Head and header were referenced in the template and in the page itself. I removed the reference to head and header from the page. Unit/Robot tests: Fixes: edited footer.html Problem: footer was hard-coded into index.html. Analysis: I moved the content into footer.html and edited for style and content. Unit/Robot tests: Fixes: edit index.html Problem: index.html contained the text for the footer and required style edits. Analysis: I removed the footer content and edited the doc for style. Unit/Robot tests: Fixes: added Font Awesome css and font files. Problem: Analysis: Unit/Robot tests: Fixes: added new background class to f5-styles.css (light gray) Problem: Analysis: Unit/Robot tests: Fixes: header not displaying inline Problem: header missing tag to display list items inline Analysis: added main-nav class to ul Unit/Robot tests: Fixes: nav bar blocks top of home page Problem: added css styling to (hopefully) pull content down Analysis: Unit/Robot tests: Fixes: modified head_for_docs.html and header.html Problem: - head_for_docs.html contained tags that were converting each page into a folder with an index.html file in it - header.html was missing liquid tag 'prepend: site.url' in css ref Analysis: - commented out code that was causing the problem in head_for_docs.html - added tag to header.html Unit/Robot tests: Fixes: the first container is overlapping with the header Problem: Analysis: - added new class to f5-style.css to increase the top margin for the first\ container Unit/Robot tests: Fixes: first container is overlapping with the header Problem: - I used the new class to increase the margin from the top of the page. Analysis: Unit/Robot tests: Fixes: testing out auto-generation of index page Problem: need a way to automatically generate a list of all documentation, organized by category Analysis: - added categories to _config.yml - added an index.html file with the liquid code to pull in the page list - added category tags and "resource: true" to the yaml header for the doc files Unit/Robot tests: Fixes: added 'misc_docs' to the categories list in _config.yml Problem: Analysis: Unit/Robot tests: Fixes: I need a way to automatically generate a docs index page. Problem: - I added categories from the master list in _config.yml to the header of each doc. Analysis: Unit/Robot tests: Fixes: modified css tags in the default layout Problem: Analysis: Unit/Robot tests: Fixes: Changed layout and added a few html tags Problem: Analysis: Unit/Robot tests: Fixes: edited _config.yml: added "baseurl: "f5-os-docs/" Problem: Analysis: Unit/Robot tests: Fixes: I need to set up the styles for the page templates. I'd like to use tocify to generate TOCs for the docs_page template. Problem: - I added a new page template -- home -- that has no styling (to use for home pages). - I added some styling to default. - I created a new layout with the tocify dependencies (css and scripts). - I added some styling and the tocify script to docs_page. Analysis: Unit/Robot tests: Fixes: This commit has the new homepage layout that contains no style tags. Problem: Analysis: Unit/Robot tests: Fixes: I changed the template for the home page to 'homepage'. I also updated the css a bit to make it look better. Problem: Analysis: Unit/Robot tests: Fixes: adding some font files Problem: Analysis: Unit/Robot tests: Fixes: TOC not automatically generated Problem: - I moved the script outside of the body. Analysis: Unit/Robot tests: Fixes: configurations for tocify Problem: I need to use tocify to generate a TOC sidebar automatically Analysis: - I added a new stylesheet. - I added a reference to the new stylesheet to head_for_docs.html. - I edited the docs_page layout. Unit/Robot tests: Fixes: I commented out the gems section from _config.yml and copied over the _lbaasconfig.yml file. Problem: Analysis: Unit/Robot tests: Fixes: corrected location of '_includes' dir in '_lbaasconfig.yml' Problem: Analysis: Unit/Robot tests: Fixes: moved /css, /fonts, /js, /media under new dir -- assets/ Problem: Analysis: Unit/Robot tests: Fixes: remove _lbaasconfig.yml Problem: Analysis: Unit/Robot tests: Travis CI and website configurations Update ci_pre-deploy.sh What I changed: I added the travis "$TRAVIS_REPO_SLUG" variable in place of the actual github repo name. Update .travis.yml What I changed: I changed `before_install` to `before_script` because the chmod doesn't need to occur before the dependencies are installed. I then placed the section after the env variables. Update ci_pre-deploy.sh What I changed: - I commented out the if / then statement for now (will test adding that back in once everything is building to my satisfaction) - I added a command to build the site to a new directory (./site_build) Update .travis.yml What I changed: - I replaced the hard-coded repo name with the travis_repo_slug variable. - I replaced the hard-coded branch name with the travis_branch variable. Update .travis.yml I forgot to use $ in the variable names in the last commit. Update cibuild.sh What I changed: - I removed the jekyll and htmlproof executables from the script (moving them to the .travis.yml file). - I added the content of ci_pre-deploy.sh here (will be deleting ci_pre-deploy bc travis will only run one script and I prefer to use this one). Delete ci_deploy.sh Delete ci_pre-deploy.sh Update .travis.yml Update cibuild.sh Added commands to build and proof back in. Update cibuild.sh What I changed: - commented out the html proofer for now, since a lot is broken in the template. Update .travis.yml What I changed: - added local directory 'site_build' as the directory from which to deploy to s3. Update README.md updated URL for travis build icon Update .travis.yml What I changed: - added travis variable for repo name in deploy section - added travis variable for branch in deploy section Fixes: No bug ID Problem: Travis build breaks bc GH_TOKEN isn't valid for the F5Networks repo. Analysis: I made travis its own github account, generated an access token, encrypted it, and added it to the .travis.yml file. Unit/Robot tests: Update cibuild.sh What I changed: -- replaced GH_TOKEN with GH_USER Update cibuild.sh What I changed: - replaced http clone url with SSH clone url Revert "Update cibuild.sh" This reverts commit e62c1908de7f76c265c2a55f6033ff5e0528b5ed. Revert "Update cibuild.sh" This reverts commit 302b21d445e5fe4ceb517a9441974d8f26901dcc. Revert "Fixes: No bug ID" This reverts commit 232ff82f307946a7500c61469f9fe9d6449c68c4. I fixed the conflict between F5Networks/master and jputrino/master. Fixes: travis builds fail on branch 'site' Problem: travis-ci is unable to build from branch 'site' because it doesn't have a .travis.yml file. Analysis: I added the 'site' branch to the travis blacklist so build will not be triggered when files are pushed to 'site'. Unit/Robot tests: Update .travis.yml What I changed: - Removed GH_TOKEN; replacing with variable GH_USER (which is configured in repos in travis-ci.com) in script. Fixes: Travis build 92 failed - could not install jekyll-pandoc Problem: Travis build #92 failed because it couldn't install the jekyll-pandoc gem. Analysis: I added jekyll-pandoc to the Gemfile. Unit/Robot tests: What I changed: - added a travis variable to the build script in the commit message that should prevent a new build on 'site' branch from kicking off a new build. - defined pygments as the jekyll highlighting tool What I changed: - started explaining the build and deployment process in the README for the f5-openstack-docs repo - made a minor edit to an 'echo' command in the build script What I changed: - entered encrypted env variables for github username and password in the build script so travis can build from the F5Networks repo. Fixes Issue #5 - Travis deployment to s3 is failing What I changed: - I added an encrypted env variable for the AWS Access key for travis-ci Fixes Issue #10 - Travis authentication issues Problem: Travis is unable to push content of site_build folder back to github repo bc authentication fails. Solution: Za and Jeff explained that as long as we have the framework for building the site in github, we don't need the actual site there, too. What I changed: - removed the commands from the cibuild.sh script that told travis to clone the repo and push to the site branch - removed the gh token section from .travis.yml - removed the 'blacklist' section from .travis.yml What I changed: added the command to copy the site build dir over to the local dir back in; the deploy section tells travis to deploy to s3 from $HOME/site_build Fixes: Pull request triggers travis build, but doesn't deploy to Amazon S3 Problem: I took out the command that copied the site build over to the home dir in travis. Analysis: I added the command back in in the previous commit; in this one, I corrected a typo that triggered an error. Unit/Robot tests: Fixes: JIRA - OPENSTACK-28: Docs Website Configuration Problem: We need a website to publicly host the OpenStack docs. Analysis: I made a website. - updated bootstrap template with some F5 Cloud Ready text and links - updated the README with some information about the ci build and deployment process Unit/Robot tests: Fixes: Use pandoc for markdown to html conversion. Problem: I need to use pandoc to convert markdown files to html files. Analysis: I added commands to the jekyll _config.yml file that tell it to use pandoc as the markdown converter. Unit/Robot tests: Fixes: edit _config.yml Problem: n/a Analysis: - change site title to F5 Cloud Ready Unit/Robot tests: Fixes: N/A -- .travis.yml config update Problem: Analysis: - added 'cache: bundler' to travis configs to speed up build - added branch whitelist - removed un-needed token Unit/Robot tests: Fixes: travis build #97 Problem: travis build failed due to an issue with jekyll Analysis: added pre-installation 'gem update' command to ensure latest versions of all gems are being used Unit/Robot tests: Fixes: N/A -- .TRAVIS/YML UPDATE Problem: Analysis: - added "--system" flag to 'gem update' to update the version of Ruby Gems, not the gems themselves (having issues with the latest v of jekyll, so don't want it updated) Unit/Robot tests: Fixes: travis build #98 failed Problem: jekyll could not build site Analysis: could be a ruby version issue; updated .travis.yml to install latest version of ruby gems Unit/Robot tests: Fixes: travis build #99n errored Problem: could not install ruby Analysis: changed to 'rvm: 2.2' Unit/Robot tests: Fixes: N/A -- jekyll build config update Problem: - I changed the markdown converter from jekyll-pandoc back to kramdown (the default) Analysis: Unit/Robot tests: Fixes: N/A -- .travis.yml config update Problem:build #101 'did not deploy to s3 provider because this branch is not permitted' Analysis: added '$TRAVISBRANCH' back to .travis.yml deploy section Unit/Robot tests: Fixes: N/A -- update .travis.yml Problem: Analysis: - change deploy 'acl' setting from 'private' to 'authenticated_read' Unit/Robot tests: Fixes: N/A -- updated index.html Problem: Analysis: Unit/Robot tests: Fixes: N/A -- added repo for 'homeless' docs Problem: - we need a place where all docs can be accessed (from across all sub-dirs) - we need a home for docs that don't clearly fit into any other repo Analysis: - added new _docs repo to house otherwise homeless docs - added index.html file to serve as docs index at a later date Unit/Robot tests: Fixes: changed name of S3 bucket to dev Problem: Analysis: Unit/Robot tests: Fixes: change name of AWS S3 bucket in .travis.yml Problem: Analysis: Unit/Robot tests: Fixes: website maintenance - added project folders using 'f5-*' naming convention - renamed existing project folder _docs to f5-os-docs - removed stock jekyll post from _posts folder - added versioning plugin gem to Gemfile and _config.yml - removed stock jekyll about page Problem: Analysis: Unit/Robot tests: Fixes: Travis build #108 broken: Liquid Exception: Variable '{{if node.fqdn in {'node-compute-1.maas'}' was not properly terminated with regexp: /\}\}/ in f5-os-docs/Demo-and-Testing-Tools-Guide.md Problem: text in a code block incorrectly interpreted as a liquid tag Analysis: added the '{%raw}' and '{%endraw}' tags Unit/Robot tests: Fixes: website configuration Problem: - added plugin to track versioning - added plugin to create project index page from the README in the github repo Analysis: Unit/Robot tests: Fixes: travis build #110 broken Problem: travis can't find dependencies for plugins Analysis: added install step to .travis.yml to bundle install the plugin gems Unit/Robot tests: Fixes: travis build #111 failed Problem: incorrect command usage (bundle install) Analysis: Unit/Robot tests: Fixes: travis build #112 failing Problem: incorrect command usage (bundle install ...) Analysis: Unit/Robot tests: Fixes: travis build #113 failing Problem: error in generate_projects.rb plugin Analysis: Unit/Robot tests: Fixes: travis build #114 failing Problem: cannot load required file in generate_projects.rb plugin Analysis: Unit/Robot tests: Fixes: travis build #115 failing Problem: generate_projects.rb load failing Analysis: Unit/Robot tests: Fixes: travis build #116 failed Problem: Analysis: Unit/Robot tests: Fixes: travis build #117 failing Problem: Analysis: Unit/Robot tests: Fixes: travis build #118 failing Problem: plugin unable to load dependencies - I moved the file out of the _plugins directory to be dealt with later Analysis: Unit/Robot tests: Fixes: travis build #119 failing Problem: Analysis: Unit/Robot tests: Fixes: travis build #119 failing Problem: Analysis: Unit/Robot tests: Fixes: travis build #121 failing Problem: Unable to install dependencies for the jekyll project pages plugin Analysis: I removed the dependencies from the config file and moved the plugins to a holding folder. Unit/Robot tests: Fixes: travis build #121 failing Problem: Liquid Exception: Tag '{%' was not properly terminated with regexp: /\%\}/ in f5-os-docs/Demo-and-Testing-Tools-Guide.md Analysis: - fixed liquid tags - removed 'index.html' (replaced with 'os_landingpage.html') Unit/Robot tests: Fixes: website maintenance Problem: - replaced 'index.html' with /os_landingpage.html' for password-protection on dev site - moved faulty plugins to 'plugins' folder Analysis: Unit/Robot tests: Fixes: travis build #123 failing Problem: travis unable to locate/access f5-openstack-dev bucket Analysis: - I added a new policy to the travis user in s3 that should allow it access to all buckets. Unit/Robot tests: Fixes: website configuration Problem: - templates for head, header, docs landing pages - add liquid tags to os_landingpage.html in place of the head and header Analysis: Unit/Robot tests: Fixes: website maintenance Problem: - configuring layout templates and landing pages Analysis: Unit/Robot tests: Fixes: Website maintenance Problem: Jekyll needs 'index.html' to build the site. We're using 'index.html' as the login page - stored in the s3 bucket for security purposes - so we need to change the name of the file in the build before deploying to the s3 dev bucket. Analysis: - edited the cibuild script to rename index.html to os_landingpage.html after copying files over to travis' home dir Unit/Robot tests: Fixes: website maintenance Problem: - added command to build script to remove the 'index.html' file after renaming it to 'os_landingpage.html' for dev builds Analysis: Unit/Robot tests: Fixes: travis build #126 failing Problem: command 'rm index.html' broke the build because the file wasn't found Analysis: - edited the script to look for the file first, then delete it if found Unit/Robot tests: Fixes: index isn't renamed before deploy to s3 from the develop branch Problem: The index.html file needs to be renamed to os_landingpage.html before the site is deployed to the dev bucket in s3 to ensure proper security. Analysis: - I edited the script to execute this command set earlier (before site build is copied to travis' home dir) Unit/Robot tests: Fixes: added frontmatter to f5-os-docs/* Problem: Analysis: Unit/Robot tests: Fixes: website maintenance Problem: - I added the site url to the config.yml file - I added a link to the f5-os-docs page to the nav bar on the home page - I created a list of the docs in the f5-os-docs folder on the f5-os-docs landing page Analysis: Unit/Robot tests: Fixes: removed section on renaming index file Problem: Analysis: Unit/Robot tests: Fixes: corrected link to f5-os-docs landing page Problem: Analysis: Unit/Robot tests: Fixes: website maintenance Problem: - converted f5-os-docs/index.html to md Analysis: Unit/Robot tests: Fixes: liquid templates Problem: Analysis: Unit/Robot tests: Fixes: add files for tocify Problem: - tocify is a jquery plugin that automatically builds a TOC Analysis: Unit/Robot tests: Fixes: add files for tocify Problem: - tocify is a jquery plugin that automatically builds a TOC Analysis: Unit/Robot tests: Fixes: modified max-width for docs_page toc side bar Fixes: modified max-width for docs_page toc side bar Revert "Fixes: modified max-width for docs_page toc side bar"; this commit was a rebase; I'm reverting it because it's causing a merge conflict upstream. This reverts commit bad90d6db7ee8a3c1cb8a361ae1cd58480bcba79. These commits configure the website. Fixes: add out-of-the-box bootstrap files; update frontmatter; update index.html Problem: Analysis: Unit/Robot tests: Fixes: website formatting Problem: Analysis: Unit/Robot tests: Fixes: website formatting Problem: Analysis: Unit/Robot tests: Fixes: website styling with F5 css Problem: Analysis: Unit/Robot tests: Fixes: add jekyll-pandoc-multiple-formats plugin to _plugins dir Problem: Analysis: Unit/Robot tests: Fixes: changes to _config.yml for jekyll-pandoc-multiple-formats Problem: Analysis: Unit/Robot tests: Fixes: travis build #139 failed Problem: Analysis: Unit/Robot tests: Fixes: travis build #140 failed Problem:"/home/travis/build/jputrino/f5-openstack-docs/_plugins/jekyll-pandoc-multiple-formats.rb:4:in `require': cannot load such file -- jekyll-pandoc-multiple-formats/version (LoadError)" Analysis: added '.rb' to jekyll-pandoc-multiple-formats/version Unit/Robot tests: Fixes: travis build #141 failed Problem: plugin dependencies won't load and break the build Analysis: - removed plugin dependencies (moved to 'plugins' folder to revisit later as needed) - modded the _config.yml file: added custom vars, the tocify gem, and switched back to kramdown Unit/Robot tests: Fixes: travis build #142 failed Problem: - added a comma between gems in _co…

jputrino added 4 commits October 21, 2015 15:48

What I changed:

1de942f

- added a travis variable to the build script in the commit message that should prevent a new build on 'site' branch from kicking off a new build. - defined pygments as the jekyll highlighting tool

What I changed:

c1d6eec

- started explaining the build and deployment process in the README for the f5-openstack-docs repo - made a minor edit to an 'echo' command in the build script

What I changed:

01875ea

- entered encrypted env variables for github username and password in the build script so travis can build from the F5Networks repo.

Fixes Issue #5 - Travis deployment to s3 is failing

e3e86fb

What I changed: - I added an encrypted env variable for the AWS Access key for travis-ci

jlongstaf added a commit that referenced this pull request Oct 22, 2015

Merge pull request #10 from jputrino/master

479c78f

Fix Authentication Issues

jlongstaf merged commit 479c78f into F5Networks:master Oct 22, 2015

jputrino mentioned this pull request Oct 22, 2015

travis unable to push to github #9

Closed

jputrino added a commit that referenced this pull request Oct 23, 2015

Merge pull request #11 from jputrino/master

223fd10

Fixes Issue #10 - Travis authentication issues

jputrino added a commit that referenced this pull request Dec 7, 2015

Merge pull request #10 from jputrino/develop

8505d26

Merge develop into master

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix Authentication Issues #10

Fix Authentication Issues #10

jputrino commented Oct 22, 2015

jlongstaf commented Oct 22, 2015

Fix Authentication Issues #10

Fix Authentication Issues #10

Conversation

jputrino commented Oct 22, 2015

jlongstaf commented Oct 22, 2015