{"id":19614647,"url":"https://github.com/activestate/cf-docs","last_synced_at":"2026-06-18T14:32:15.914Z","repository":{"id":66048014,"uuid":"4423222","full_name":"ActiveState/cf-docs","owner":"ActiveState","description":"mirror of the gerrit repo at http://reviews.cloudfoundry.org/","archived":false,"fork":false,"pushed_at":"2012-06-19T20:31:12.000Z","size":5023,"stargazers_count":0,"open_issues_count":0,"forks_count":3,"subscribers_count":52,"default_branch":"master","last_synced_at":"2025-02-26T17:48:20.117Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ActiveState.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2012-05-23T17:40:00.000Z","updated_at":"2014-11-06T08:05:18.000Z","dependencies_parsed_at":"2023-02-19T22:00:29.400Z","dependency_job_id":null,"html_url":"https://github.com/ActiveState/cf-docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ActiveState/cf-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ActiveState%2Fcf-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ActiveState%2Fcf-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ActiveState%2Fcf-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ActiveState%2Fcf-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ActiveState","download_url":"https://codeload.github.com/ActiveState/cf-docs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ActiveState%2Fcf-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34495377,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-18T02:00:06.871Z","response_time":128,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2024-11-11T10:53:13.898Z","updated_at":"2026-06-18T14:32:15.893Z","avatar_url":"https://github.com/ActiveState.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"Copyright (c) 2006-2012 VMware, Inc. All Rights Reserved.\n\n# docs.cloudfoundry.com\n\nThese are the Cloud Foundry docs built with [nanoc][nanoc].\n\n## Setup\n\nRuby 1.9 is required to build the site. This repo assumes(via .rvmrc) you have\n[RVM](https://rvm.beginrescueend.com/) and Ruby 1.9.2 installed and a docs gemset\n\nTo create the docs gemset follow these steps:\n\n    $ rvm use 1.9.2\n    Using /Users/\u003cyour_username\u003e/.rvm/gems/ruby-1.9.2-p290\n\n    $ rvm gemset create docs\n    'docs' gemset created (/Users/\u003cyour_username\u003e/.rvm/gems/ruby-1.9.2-p290@docs).\n\n    $ rvm gemset use docs\n\nUse this command to get all the necessary gems to build the docs:\n\n    $ bundle install\n\nYou can see the available commands with nanoc:\n\n    nanoc -h\n\nNanoc has [some nice documentation](http://nanoc.stoneship.org/docs/3-getting-started/)\nto get you started.  Though if you're mainly concerned with editing or\n adding content, you won't need to know much about nanoc.\n\n[nanoc]: http://nanoc.stoneship.org/\n\n\n## Writing Docs\n* Add a markdown doc `mydoc.md` to the `content` folder. If you need to add screenshots, add\nthem to `static/images/screenshot/\u003cpage-name\u003e/` folder\n\n* Specify title, description and tags.\n* Reuse tags instead of making new ones wherever possible.\n\n### Changing the layout\nIf you need to change the layout you can edit default.haml in the layouts folder.\nMany of the values used in this template are set in the confi.yaml including:\n\n* Base urls for all the links\n* Test version of docs vs production version of docs\n* Social buttons preferences\n\n### Colorized Code Blocks\n\nYou can have nanoc pretty print (colorize) your code, by placing the code\ninside a fenced block quote (three backquotes) followed by language name.\nThis style is compatible with GitHub Flavored Markdown code blocks.\n\nExample:\n\n    ``` ruby\n    # this is a simple Ruby Sinatra app\n    get '/' do\n      \"Hello from Sinatra!\"\n    end\n    ```\n\nSupported languages include java, javascript, ruby, erb, groovy, scala, bash\nhtml and xml (see `Rules` for full list).\n\nSome things to watch out for:\n\n+ Avoid `TAB` characters in the code, as tabs confuse the nanoc filters.\n+ Make sure the three backquotes have no leading spaces\n+ You dont have to escape HTML or XML inside the fenced quotes\n\n## Development\n\nNanoc compiles the site into static files living in `./output/public`.  It's\nsmart enough not to try to compile unchanged files:\n\n```bash\n$ nanoc tags\n$ nanoc compile\nLoading site data...\nCompiling site...\n   identical  [0.37s]  output/public/frameworks.html\n   identical  [1.54s]  output/public/frameworks/java/spring/grails.html\n   identical  [12.77s]  output/public/frameworks/java/spring/spring.html\n   identical  [1.01s]  output/public/frameworks/nodejs/nodejs.html\n   identical  [0.08s]  output/public/frameworks/ruby/installing-ruby.html\n   identical  [0.57s]  output/public/frameworks/ruby/rails-3-0.html\n   identical  [2.05s]  output/public/frameworks/ruby/rails-3-1.html\n   identical  [0.54s]  output/public/frameworks/ruby/ruby-simple.html\n   identical  [0.08s]  output/public/frameworks/ruby/ruby.html\n   identical  [3.13s]  output/public/frameworks/ruby/sinatra.html\n   identical  [0.90s]  output/public/frameworks/scala/scala.html\n   identical  [0.05s]  output/public/getting-started.html\n   identical  [0.07s]  output/public/index.html\n   identical  [0.09s]  output/public/infrastructure/micro/installing-mcf.html\n   identical  [0.14s]  output/public/infrastructure/micro/using-mcf.html\n   identical  [0.07s]  output/public/infrastructure/overview.html\n   identical  [0.06s]  output/public/quick-start.html\n      update  [0.53s]  output/public/services.html\n\n   Site compiled in 42.48s.\n```\n\nYou can setup whatever you want to view the files.  If you have the adsf\ngem, however (I hope so, it was in the Gemfile), you can start Webrick:\n\n    $ nanoc view\n\nYou can then open your browser to http://localhost:3000\n\nCompilation times got you down?  Use `autocompile`!\n\n    $ nanoc tags\n    $ nanoc autocompile\n\nThis starts a web server too, so there's no need to run `nanoc view`.\nOne thing: remember to add trailing slashes to all nanoc links!\n\nSince Cloud Foundry doesn't support deploying a static app we use Sinatra. The Sinatra app is inside the output doc\nYou can run this app by doing\n\n    $ cd output\n    $ bundle install\n    $ ruby sample.rb\n\nYou can then open your browser to http://0.0.0.0:4567/ and see the same pages\nas with `nanoc view` and opening http://localhost:3000\n\n## Contributing to the documentation\n\n* Signup at [https://reviews.cloudfoundry.org](https://reviews.cloudfoundry.org)\n* Install the `gerrit-cli` gem\n* `gerrit clone` the repo `ssh://\u003cyour-username\u003e@reviews.cloudfoundry.org:29418/cf-docs` and cd into it\n* Update the pages (inside of folder `content`)\n* Remove the old pages `rm -rf output/public`\n* If you changed tags, regenerate them with `nanoc tags`\n* Recompile `nanoc compile`\n* Test  `nanoc autocompile` or `nanoc view`\n* Commit your change `git commit -am \"Changes to have a simpler tutorial\"`\n* Squash commits into one if you want to send your changes upstream.\n* Submit changes with `gerrit push`\n\n# License\n\nThis work is licensed under a [Creative Commons Attribution-ShareAlike 3.0 License](http://creativecommons.org/licenses/by-sa/3.0/)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Factivestate%2Fcf-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Factivestate%2Fcf-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Factivestate%2Fcf-docs/lists"}