{"id":27359312,"url":"https://github.com/rackerlabs/support-how-to","last_synced_at":"2025-04-13T00:28:05.985Z","repository":{"id":37081691,"uuid":"233150234","full_name":"rackerlabs/support-how-to","owner":"rackerlabs","description":":new: Rackspace How-To Support Articles :fire:","archived":true,"fork":false,"pushed_at":"2024-07-11T19:36:31.000Z","size":393188,"stargazers_count":12,"open_issues_count":35,"forks_count":88,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-04-13T00:27:59.677Z","etag":null,"topics":["how-to","rackspace","support"],"latest_commit_sha":null,"homepage":"https://docs.rackspace.com/support/how-to/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rackerlabs.png","metadata":{"files":{"readme":"README.adoc","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-01-11T00:00:00.000Z","updated_at":"2024-08-27T13:40:40.000Z","dependencies_parsed_at":"2024-07-11T22:22:23.447Z","dependency_job_id":null,"html_url":"https://github.com/rackerlabs/support-how-to","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rackerlabs%2Fsupport-how-to","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rackerlabs%2Fsupport-how-to/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rackerlabs%2Fsupport-how-to/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rackerlabs%2Fsupport-how-to/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rackerlabs","download_url":"https://codeload.github.com/rackerlabs/support-how-to/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248650827,"owners_count":21139670,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["how-to","rackspace","support"],"created_at":"2025-04-13T00:28:05.427Z","updated_at":"2025-04-13T00:28:05.978Z","avatar_url":"https://github.com/rackerlabs.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":":toc: macro\n:toc-title:\n\n= Support How-To\n\nhttps://app.netlify.com/sites/docs-support-how-to/deploys[image:https://api.netlify.com/api/v1/badges/3bdf5895-daf4-4722-8e5c-5f2fde76ab44/deploy-status[title=\"Netlify Status\"]]\n\ntoc::[]\n\nThis repository contains the source code for our https://docs.rackspace.com/support/ website.\n\nThe content is written in link:https://github.com/yuin/goldmark/[Goldmark-style Markdown] and\nlink:https://asciidoctor.org/docs/asciidoc-syntax-quick-reference/[AsciiDoc]. It is generated by\nlink:https://gohugo.io/[Hugo].\n\n== Requirements\n\nTo build this site locally, you can either install the dependencies directly on your development\nmachine.\n\n=== Local set up\n```sh\n npm i -g netlify-cli\n netlify init\n netlify build\n netlify dev\n netlify deploy\n```\n\n==== Install Hugo directly\n\nTo build the documentation locally, install link://https://gohugo.io/[Hugo] and have the `hugo`\ncommand available in your PATH. Use **Hugo version 0.78** or newer. You can install `hugo` by using\nyour system's package manager. For example, on OSX, type the following command to install `hugo`\nwith Homebrew:\n\n```sh\nbrew install hugo\n```\n\nFor more information about how to install Hugo, see\nlink:https://gohugo.io/getting-started/installing/[Hugo installation documentation].\n\n==== Install Asciidoctor directly\n\nThe documentation build also requires the Asciidoctor Ruby package to process `.adoc` files. To\navoid having to install Ruby packages as the root user (with sudo), add the following lines to the\n`.bashrc` (for Bash Shell) or `.zshenv` (for Z Shell) in your home directory:\n\n```sh\nexport GEM_HOME=$HOME/.gem\nif [ -d $GEM_HOME ]; then \\\n    export PATH=$GEM_HOME:$PATH; fi\n```\n\nCreate the `~/.gem` directory:\n\n```sh\nmkdir -p $HOME/.gem\n```\n\nLog in and log out (or `source` the environment file you changed previously) to pick up the changes.\n\nNow, install Asciidoctor:\n\n`make install`\n\n====  Build the documentation locally\n\nBuild your content locally and check for build errors before submitting a pull request.\n\n1. Change directory to the root directory of your document repository.\n2. Type the following command:\n\n```sh\nnetlify build\n```\n\n====  Start a local web server\n\nTo preview documents in a web browser such as Chrome, start the Hugo server on your device.\n\nHugo has a live `serve` command that runs a small, lightweight web server on your computer so you can\ntest your site locally without needing to upload it anywhere.  As you make changes to files in your project,\nit rebuilds your project and reloads the browser for you.\n\nTo start the Hugo server, perform the following steps:\n\n1. Change directory to the root directory of your document repository.\n2. Run the following command:\n\n`netlify dev`\n\nThe Hugo server displays some messages while it starts up.  The last line should be:\n\n`Web Server is available at http://localhost:1313/ (bind address 127.0.0.1)\nPress Ctrl+C to stop`\n\nYou should now be able to access the Support How-To using the generated link. You cannot use the Support How-To dropdown\nto navigate to your new article. To access your article:\n\n1. Select the link generated by Hugo.\n2. In the search bar type '/support/how-to/' after the existing local address.\n3. Copy and paste the information from the slug section of your metadata after the '/support/how-to/' text.\n\nThis running instance supports live reload. Changes you make to files are automatically updated in\nyour running instance.\n\nSome files may not be supported for live reload. If you are not automatically seeing your changes,\nyou may need to restart the server. You can restart the server by pressing 'ctrl-c' and running\n`netlify dev` again.\n\nIf everything is working as expected, you will see output similar to:\n\n```\nStart building sites …\nhugo v0.84.2+extended darwin/amd64 BuildDate=unknown\n\n                   | EN-US\n-------------------+--------\n  Pages            |  1838\n  Paginator pages  |     0\n  Non-page files   |   800\n  Static files     |    89\n  Processed images |     0\n  Aliases          |     0\n  Sitemaps         |     1\n  Cleaned          |     0\n\nBuilt in 3988 ms\nWatching for changes in /rackerlabs/support-how-to/{archetypes,content,i18n,layouts,static}\nWatching for config changes in /rackerlabs/support-how-to/config.toml\nEnvironment: \"development\"\nServing pages from memory\nRunning in Fast Render Mode. For full rebuilds on change: hugo server --disableFastRender\nWeb Server is available at //localhost:1313/ (bind address 127.0.0.1)\nPress Ctrl+C to stop\n\n   ┌─────────────────────────────────────────────────┐\n   │                                                 │\n   │   ◈ Server now ready on http://localhost:8888   │\n   │                                                 │\n   └─────────────────────────────────────────────────┘\n\n```\n\nThis running instance supports live reload. Changes you make to files should be automatically\nupdated in your running instance.\n\nSome files may not be supported for live reload. If you are not automatically seeing your changes live you may need to restart the server. You can restart the server by pressing 'ctrl-c' and running\n`netlify dev` again.\n\n==  Project directory structure\n\n```\n├── [archetypes]- Directory where you define the content, tags, categories, etc.\n├── [content] - Directory that contains the content of the site.\n├── [assets] - Directory that contains stylesheets.\n├── [src] - Directory that contains Javascript.\n├── [i18n] - Directory that contains Language Support.\n├── [layouts] - Directory that contains Go HTML/template library used to template and format the site.\n├── [public] - (Doesn't exist until generated) Directory that contains the generated content for the site.  Should be part of your git.ignore file.\n├── [static] - Directory for any static files to be compiled into the web site (fav icons, etc.).\n├── Makefile\n├── config.toml - Main configuration file, where you define the web site title, URL, language, etc.\n├── README.adoc (This file)\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frackerlabs%2Fsupport-how-to","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frackerlabs%2Fsupport-how-to","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frackerlabs%2Fsupport-how-to/lists"}