{"id":27359638,"url":"https://github.com/rackerlabs/docs-landing-page","last_synced_at":"2025-04-13T00:33:14.951Z","repository":{"id":37940740,"uuid":"275177856","full_name":"rackerlabs/docs-landing-page","owner":"rackerlabs","description":"Rackspace technical documentation landing page","archived":false,"fork":false,"pushed_at":"2023-07-05T21:01:34.000Z","size":26543,"stargazers_count":3,"open_issues_count":5,"forks_count":7,"subscribers_count":9,"default_branch":"master","last_synced_at":"2024-04-14T09:07:17.658Z","etag":null,"topics":["documentation","rackspace"],"latest_commit_sha":null,"homepage":"https://docs.rackspace.com/","language":"SCSS","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":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-06-26T14:40:25.000Z","updated_at":"2023-01-22T19:53:50.000Z","dependencies_parsed_at":"2023-02-15T03:16:02.977Z","dependency_job_id":null,"html_url":"https://github.com/rackerlabs/docs-landing-page","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%2Fdocs-landing-page","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rackerlabs%2Fdocs-landing-page/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rackerlabs%2Fdocs-landing-page/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rackerlabs%2Fdocs-landing-page/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rackerlabs","download_url":"https://codeload.github.com/rackerlabs/docs-landing-page/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248650550,"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":["documentation","rackspace"],"created_at":"2025-04-13T00:33:14.428Z","updated_at":"2025-04-13T00:33:14.946Z","avatar_url":"https://github.com/rackerlabs.png","language":"SCSS","funding_links":[],"categories":[],"sub_categories":[],"readme":":toc: macro\n:toc-title:\n\n= Docs Landing Page\n\nhttps://app.netlify.com/sites/docs-rackspace-com/deploys[image:https://api.netlify.com/api/v1/badges/ea5a1331-0476-4664-83af-47ba3ac87159/deploy-status[title=\"Netlify Status\"]] https://github.com/rackerlabs/docs-landing-page/graphs/contributors[image:https://img.shields.io/github/contributors-anon/rackerlabs/docs-landing-page?style=plastic[title=GitHub contributors]]\n\ntoc::[]\n\nThis repository contains the source code for https://docs.rackspace.com/ website.\n\nThe website is written in link:https://asciidoctor.org/docs/asciidoc-syntax-quick-reference/[AsciiDoc], generated by using link:https://gohugo.io/[Hugo], and hosted on GitHub.\n\n== Requirements\n\nThe Docs site runs on top of Hugo. To run an instance locally you need to either install\nHugo and AsciiDoctor locally.\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 and AsciiDoctor locally\n\nIf you want to install the required tools, you must first install link://https://gohugo.io/[Hugo]\nand have the `hugo` command available in your PATH. Use **Hugo version 0.78** or newer. You can\ninstall `hugo` by using your system's package manager. For example, on OSX, type the following\ncommand to install `hugo` with Homebrew:\n\n```sh\nbrew install hugo\n```\n\nFor more information about how to install Hugo please see the\nlink:https://gohugo.io/getting-started/installing/[installation documentation].\n\nYou also need Asciidoctor and Gem to run the local Docs site. Install those tools and verify them by\nrunning the following commands:\n\n`install asciidoctor: sudo gem install asciidoctor -N`\n`verify asciidoctor -v`\n`verify gem —help`\n\nAlternatively, use the `npm install` command to install Asciidoctor by using link:https://rubygems.org[Ruby Gem]\nand Bundler. You need to have the `gem` command in your path. For more information, see the\nlink:https://rubygems.org/pages/download[Ruby Gem installation docs].\n\n====  Build the documentation locally\n\nBuild your content locally and check for build errors.\n\n1. Change directory to the root directory of your document repository.\n2. Run 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\nDeveloper Docs runs on top of Webpack.\n\n```sh\nnetlify dev\n```\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\nThis running instance should support 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\nyou may need to restart the server. You can restart the server by pressing 'ctrl-c' and running `netlify dev`\nagain.\n\n\nYou should now be able to access the developer docs homepage, for example, from: link:http://localhost:1313/[http://localhost:1313/]\n\nThis running instance should support 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\nyou 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├── [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 (style sheets, JavaScript, images, robots.txt, 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\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frackerlabs%2Fdocs-landing-page","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frackerlabs%2Fdocs-landing-page","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frackerlabs%2Fdocs-landing-page/lists"}