build and deploy this website

This procedure steps through the process that was undertaken to build and deploy this website on a Mac.

Note: Under normal circumstances, a procedure like this would be broken into several tasks with many assumptions called out. Keep in mind that the purpose of this procedure is to demonstrate an ability to leverage a breadth of DITA authoring capabilities.
The following tools were utilized for this task:
Table 1. Tools for building pbjWrites.work
Tool Purpose or Role
Oxygen XML Editor Used to author the source files and publish the output web files
Snagit Used for screenshots and playable gifs
GoDaddy Used to purchase domain, hosting, and web security services
Homebrew Used as prerequisite to installing Git
Git Used version controlling the source and output files
GitHub Used as source and output file repository
Terminal Used as Git CLI
Obtain Oxygen XML Editor
  1. In a browser, navigate to https://www.oxygenxml.com/xml_editor/download_oxygenxml_editor.html.
  2. Click Download.
    A form appears alongside the download pop-up.
  3. Select a location to save the Oxygen XML Editor download.
  4. Fill-out the form with a valid email address in order to receive the 30-day trial license.
  5. Click Get Trial License.
  6. Check email and copy the trial license text.
  7. Open the Oxygen XML Editor download package.
  8. Paste the license information.
Install Git, create a Git repository in GitHub, add SSH public key to GitHub, and clone repository locally
  1. Open Terminal.
  2. In a browser, navigate to https://brew.sh/ and copy the following "Install Homebrew" command and paste it into Terminal. 
    $ /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
  3. Hit return to install Homebrew.
  4. After the Homebrew installation completes, navigate to https://git-scm.com/book/en/v1/Getting-Started-Installing-Git and copy the following command in Terminal. 
    $ brew install git
  5. Hit return to install Git.
  6. In a browser, navigate to https://github.com.
  7. Login with credentials.
  8. In the top toolbar, click + > New Repository.
    A form will appear.
  9. In the Repository name field, type dita_portfolio.
  10. In the Description field, type a description.
  11. Keep the Public repository setting selected.
  12. Select the checkbox to Initialize this repository with a README.
  13. Click Create repository.
  14. From the repository page, click Clone or download.
    A dropdown menu appears.
  15. In the upper right of the dropdown menu, click Use SSH.
  16. Click the copy button to copy the clone repository path which is in the following format: 
    git@github.com:<username>/<repository name>.git
  17. In Terminal, navigate to the desired root folder for the Git repository with the cd command.
    For example:
    $ cd dita_portfolio
  18. Run the following command: 
    $ git clone git@github.com:pbjStand/dita_portfolio.git
    Experience an error and bang head against the table since the SSH keys were forgotten.
  19. Navigate to the public key and copy it.
    If not familiar with SSH keys, use the following guidance from GitHub: https://help.github.com/en/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent
    DANGER: Do NOT copy the private key or allow the private key to be exposed to anyone or anywhere. Always use the key file that ends with .pub. If the private key is ever exposed, delete the keys and generate new ones.
  20. In a browser, navigate to https://github.com.
  21. In the top toolbar, click on the profile picture then Settings.
  22. From the Settings page, click SSH and GPG Keys.
  23. Click New SSH key.
  24. Paste the public key.
  25. Click Add SSH key.
  26. Repeat Step 26.
    Terminal will prompt for a passphrase.
  27. Enter passphrase for the key.
    The dita_portfolio repository is established locally.
Authoring website source files and generating website output files
  1. Open the Oxygen XML Editor application.
  2. From the Mac menu bar, select Project > New Project.
    The new project dialog box appears.
  3. For the new project local, select the local dita_portfolio folder.
  4. Click Save.
  5. Create DITA document.
    This means the source files such as DITA maps and topics.
  6. From the Mac toolbar, select Document > Transformation > Apply Transformation Scenario(s).
    A pop-up will appear.
  7. Select the DITA Map WebHelp Responsive output type.
  8. Click Apply.
    This will generate the website output files.
Stage, commit, and push files from local repository to remote GitHub repository
  1. In Terminal, run the following command from the dita_portfolio root directory: 
    $ git add -A
    This will stage all repository changes (for example, file additions and file removals).
  2. Now run the following comand: 
    $ git commit -am '<insert commit message>'
    This takes a snapshot of files in the version history.
  3. Last, run the following command: 
    $ git push
    Terminal will prompt for a passphrase.
  4. Enter passphrase for the key.
    The latest committed local dita_portfolio version is pushed to the remote GitHub repository.
Create zip of website output files
  1. Open Finder.
  2. Navigate to dita_portfolio/out/webhelp-responsive.
  3. Select all files inside the webhelp-responsive folder with Cmd-A.
  4. On the selected files, right-click > Compress [x number of] Items.
    All website files are now contained in the webhelp-responsive folder as file called Archive.zip.
GoDaddy purchase, file upload, and security enhancement
  1. In a browser, navigate to https://www.godaddy.com.
  2. Buy domain, hosting, and security services.
    Condensing this step for everyone's sake. The outcome is that the pbjWrites.work domain is now associated with the hosted service.
  3. From the GoDaddy My Products tab under the Web Hosting section, click Manage.
  4. From the web hosting management page, click the File Manager.
  5. Double click the public_html folder.
    This folder is where website files are exposed to the internet.
  6. Click Upload.
    A new upload page appears.
  7. Select (or drag and drop in the window) the Archive.zip file.
  8. Go back to the File Manager page.
  9. Click Reload to refresh the files.
  10. In the file list, find the Archive.zip and right-click > Extract.
    The files are now uncompressed and the website is available momentarily. Check pbjWrites.work to verify.
  11. To ensure that the website visitors feel safe, consider redirecting HTTP traffic to HTTPS with the following GoDaddy guidance: https://www.godaddy.com/help/redirect-my-cpanel-website-to-https-27870