mlavi.notes.md

Hands On Workshops: How To

• Suggestions from How to contribute to Nutanix Workshops
  • git clone https://github.com/nutanixworkshops/workshop-repo-template
    • recommend using this .gitignore
• Bootcamp Authoring and Publishing Guide
  • https://github.com/shuguet/how Docker container build/live webserver

RST

• https://docutils.sourceforge.io/docs/user/rst/quickref.html and more from the source.
• http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
  • Roles
  • Directives

Atom Plugins

• git-plus
• git-log
• tree-view-git-branch
• tree-view-git-status
• language-sphinx
• RESEARCH:
  • Sphinx-Preview
  • https://hub.docker.com/r/dldl/sphinx-server/tags
  • https://github.com/dldl/sphinx-server

OS Packages

• http://www.sphinx-doc.org/en/master/usage/installation.html
  • brew for the win with pipenv
    • See [dotfiles/dmz/python.md#Linux]
  • apt-get install python3-sphinx

    • sphinx-build --help = Sphinx v1.6.7

      Suggested packages: docutils-doc fonts-linuxlibertine | ttf-linux-libertine texlive-lang-french texlive-latex-base texlive-latex-recommended python-jinja2-doc ttf-bitstream-vera python3-sphinx-rtd-theme dvipng texlive-latex-extra texlive-fonts-recommended texlive-generic-extra latexmk sphinx-doc

      update-alternatives: using /usr/share/docutils/scripts/python3/rst-buildhtml to provide /usr/bin/rst-buildhtml (rst-buildhtml) in auto mode

• https://www.sphinx-doc.org/en/master/usage/configuration.html
• https://docs.python-guide.org/dev/virtualenvs/

Execute

• Setup:

  # git forked upstream https://github.com/jncox/calmbootcamp
  ghq clone mlavi/calmbootcamp
  ghq-look calmbootcamp
  pipenv--three install sphinx sphinxcontrib-fulltoc sphinx-bootstrap-theme sphinx_fontawesome
  git checkout -B hybridcloudeng
  

• Author:

  ghq-look calmbootcamp
  git checkout hybridcloudeng
  pipenv shell
  
  sphinx-build . _build
  URL=_build/index.html ; firefox $URL || brave-browser $URL ; echo $URL
  
  sphinx-build . _build && firefox $_/index.html || brave-browser $_/index.html
  
  

• _build/index.html

• cd calm_marketplace/images; for i in ls 510*png; do git mv $i 5.10/${i:3} ; done

• pipenv install --dev watchdog

  • https://github.com/gorakhargosh/watchdog

    watchmedo shell-command --pattern='Vagrantfile;*rb' --command='vagrant provision; echo' --recursive
    
    PAGE=x watchmedo shell-command --pattern='*.md' --command='landslide --relative --embed --quiet $PAGE.md --destination $PAGE.html' --recursive &
    
    set PAGE filename ; watchmedo shell-command --pattern='*.md' --command='landslide --relative --embed --quiet $PAGE.md \
     --destination $PAGE.html' --recursive &
    
    watchmedo shell-command --pattern="*.md" --command="landslide --relative --embed --quiet devops-demystified.md --destination devops-demystified.html" &
    

  • watchmedo shell-command --help

  watchmedo shell-command --wait --recursive --ignore-patterns='_build' --patterns='*rst'
  --command='clear; date; _FI=${watch_src_path}; echo "-- $_FI" ; make clean && make html && firefox file:pwd/_build/html/${_FI%%rst}html' &

Content Bugs

#. ncox: calm_day2/calm_day2.rst:19: WARNING: undefined label: taskman (if the link has no caption the label must precede a section header) #. ncox: calm_marketplace/calm_marketplace.rst:219: WARNING: image file not readable: calm_marketplace/images/5.10/marketplace_p2_12.png

Content Warnings