cloudfoundry / docs-book-cloudfoundry Goto Github PK

When I open the docs with Internet Explorer (IE 11), the left padding of the main content doesn't show and the content borders right to the edge of the left navigation.

https://docs.cloudfoundry.org/ is lacking the usual "Create a pull request or raise an issue on the source for this page in GitHub" mentionned at https://docs.cloudfoundry.org/concepts/contribute.html#contribute

Findind that this PR to this page actually match https://github.com/cloudfoundry/docs-book-cloudfoundry/blob/master/master_middleman/source/index.html.md.erb took me a while of googling

This is a refinement over #30

I tried to run the bookbinder with my local changes following the description in contributing-pull-requests using Ruby 2.7.0 and it failed with:

bundle exec bookbinder watch
Traceback (most recent call last):
	23: from /Users/<user>/.rvm/gems/ruby-2.7.0/bin/ruby_executable_hooks:22:in `<main>'
	22: from /Users/<user>/.rvm/gems/ruby-2.7.0/bin/ruby_executable_hooks:22:in `eval'
	21: from /Users/<user>/.rvm/gems/ruby-2.7.0/bin/bookbinder:23:in `<main>'
	20: from /Users/<user>/.rvm/gems/ruby-2.7.0/bin/bookbinder:23:in `load'
	19: from /Users/<user>/.rvm/gems/ruby-2.7.0/gems/bookbindery-9.12.1/install_bin/bookbinder:3:in `<top (required)>'
	18: from /Users/<user>/.rvm/gems/ruby-2.7.0/gems/bookbindery-9.12.1/install_bin/bookbinder:3:in `require_relative'
	17: from /Users/<user>/.rvm/gems/ruby-2.7.0/gems/bookbindery-9.12.1/lib/bookbinder/cli.rb:6:in `<top (required)>'
	16: from /Users/<user>/.rvm/gems/ruby-2.7.0/gems/bookbindery-9.12.1/lib/bookbinder/cli.rb:6:in `require_relative'
	15: from /Users/<user>/.rvm/gems/ruby-2.7.0/gems/bookbindery-9.12.1/lib/bookbinder/commands/collection.rb:21:in `<top (required)>'
	14: from /Users/<user>/.rvm/gems/ruby-2.7.0/gems/bookbindery-9.12.1/lib/bookbinder/commands/collection.rb:21:in `require_relative'
	13: from /Users/<user>/.rvm/gems/ruby-2.7.0/gems/bookbindery-9.12.1/lib/bookbinder/preprocessing/dita_html_preprocessor.rb:2:in `<top (required)>'
	12: from /Users/<user>/.rvm/gems/ruby-2.7.0/gems/bookbindery-9.12.1/lib/bookbinder/preprocessing/dita_html_preprocessor.rb:2:in `require_relative'
	11: from /Users/<user>/.rvm/gems/ruby-2.7.0/gems/bookbindery-9.12.1/lib/bookbinder/subnav/navigation_entries_from_html_toc.rb:2:in `<top (required)>'
	10: from /Users/<user>/.rvm/gems/ruby-2.7.0/gems/bookbindery-9.12.1/lib/bookbinder/subnav/navigation_entries_from_html_toc.rb:2:in `require'
	 9: from /Users/<user>/.rvm/gems/ruby-2.7.0/gems/activesupport-4.2.11.1/lib/active_support/all.rb:3:in `<top (required)>'
	 8: from /Users/<user>/.rvm/gems/ruby-2.7.0/gems/activesupport-4.2.11.1/lib/active_support/all.rb:3:in `require'
	 7: from /Users/<user>/.rvm/gems/ruby-2.7.0/gems/activesupport-4.2.11.1/lib/active_support/core_ext.rb:1:in `<top (required)>'
	 6: from /Users/<user>/.rvm/gems/ruby-2.7.0/gems/activesupport-4.2.11.1/lib/active_support/core_ext.rb:1:in `each'
	 5: from /Users/<user>/.rvm/gems/ruby-2.7.0/gems/activesupport-4.2.11.1/lib/active_support/core_ext.rb:2:in `block in <top (required)>'
	 4: from /Users/<user>/.rvm/gems/ruby-2.7.0/gems/activesupport-4.2.11.1/lib/active_support/core_ext.rb:2:in `require'
	 3: from /Users/<user>/.rvm/gems/ruby-2.7.0/gems/activesupport-4.2.11.1/lib/active_support/core_ext/object.rb:3:in `<top (required)>'
	 2: from /Users/<user>/.rvm/gems/ruby-2.7.0/gems/activesupport-4.2.11.1/lib/active_support/core_ext/object.rb:3:in `require'
	 1: from /Users/<user>/.rvm/gems/ruby-2.7.0/gems/activesupport-4.2.11.1/lib/active_support/core_ext/object/duplicable.rb:106:in `<top (required)>'
/Users/<user>/.rvm/gems/ruby-2.7.0/gems/activesupport-4.2.11.1/lib/active_support/core_ext/object/duplicable.rb:111:in `<class:BigDecimal>': undefined method `new' for BigDecimal:Class (NoMethodError)

With Ruby 2.6.5 it worked. Will be great to document the supported Ruby versions to run the bookbinder or add support for the latest Ruby version like 2.7.0 or 3.0.0. I couldn't find any hints which Ruby version should I use.

I've been wanting to contribute more and more to the Cloud Foundry documentation, but when I come across a page that I want to modify, it's hard to find the corresponding Markdown file across the various repositories. It would be great to have an "improve this page" link to take the contributor to the web editing view on GitHub. Thanks!

I get this error message:

Amits-MacBook-Pro:docs-book-cloudfoundry agupta$ bin/bookbinder bind local
  skipping (not found) /Users/agupta/workspace/docs-layout-repo
The method copy_contents cannot copy the contents of the directory '/Users/agupta/workspace/docs-layout-repo' because it was not found.

Once I clone the docs-layout-repo sibling to this repo, things work fine. README should be updated to describe this requirement, or it should work without it please. I know in the past it worked without it. Also, any reason why that repo is in the pivotal-cf org and not cloudfoundry?

All Services links are /services/services/foo.html. This appears to be the case only for services links. Instead, links to services pages should be /services/foo.html

I tried deploying to CF v251 in order to be able to test some copy changes in usability testing.

I hit the problems described in cloudfoundry/ruby-buildpack#75 because this app tries to use ruby 2.3.0, which is not supported by recent ruby buildpacks.

As pointed out in that issue, this happens because final_app/Gemfile contains this line:

ruby '2.3.0'

I don't really understand how to fix this myself.

Whenever I try to build this book lately, I get error build/adminguide/securing-traffic.html or similar errors.

When running with --verbose, it looks as follows:

error  build/adminguide/securing-traffic.html
Is a directory @ io_fread - /app/docs-book-cloudfoundry/output/master_middleman/source/adminguide/

Am I the only one having this issue? I've tried on multiple systems and in Docker containers but it's always the same...

Go to https://www.cloudfoundry.org/get-started/#cf-concepts

Scroll to Cloud Foundry Concepts > General Concepts
"App Container Lifecycle" opens "https://www.cloudfoundry.org/devguide/deploy-apps/app-lifecycle.html"

It should open "https://docs.cloudfoundry.org/devguide/deploy-apps/app-lifecycle.html"

All other links work fine

There are two sub-nav menus for Service Mesh Architecture.

Actual

Expected
Only one link.

Inspired by OpenStack Training Guide, will we have team to work on this kind of work?

I am very interest to join this work, and doing like "hackathon" in weekly or biweekly to test the guide, to make sure this guide is working well in several environment

I found that CF people mostly using Mac /Brew, and I am not .. that make problem when testing .

take a look of this work?

1. CF Installation Guide
2. CF Development Guide
3. CF Deployment Guide
4. CF Administration Guide

http://docs.openstack.org/training-guides/content/under-construction.html

F

While the search of the documentation on https://docs.cloudfoundry.org works well in Chrome, in Safari (and possibly other browsers) the results get cut off. The search results panel gets hidden by the main content and it's impossible to read the search results. I am using Safari 9.0.3 on Mac OS X 10.11.3.

It is not always obvious for docs-* contributors to know which repo and which source file correspond to the current page displayed on https://docs.cloudfoundry.org/

The bosh.io docs part has a great feature where each page displays a "Contribute changes to this page" with the deep link to the corresponding source file into github, making it easy to fork the corresponding repo and contribute a PR

See for instance http://bosh.io/docs/director-configure-blobstore.html

http://docs.cloudfoundry.org/cf-cli does not automatically redirect to HTTPS.

$ curl -I http://docs.cloudfoundry.org/cf-cli/
HTTP/1.1 200 OK
...

Expected something like:

$ curl -I http://www.cloudfoundry.org/
HTTP/1.1 301 Moved Permanently
Content-Type: text/html; charset=UTF-8
Location: https://www.cloudfoundry.org/
...

Not sure if there's any reason why HTTPS couldn't or shouldn't be enforced?

Originally reported here: cloudfoundry/cli#1306

When trying to build my book (which is an up to date fork of this one), it asks me for a username and password for the repo cloudfoundry/docs-uaa. Is this just a misconfiguration or is this repo not public yet? I am currently stuck because I cannot build my docs.

It looks like the docs-cf-admin repo is not linked to from the Readme.

Now that cloudfoundry/python-buildpack#395 is merged, we should document its usage

Search option is not working in cloud foundry documentation page (https://docs.cloudfoundry.org/), whenever we search any keyword its not showing any result.

For Cloud Foundry providers it would be nice, if we could use a specific shared domain that we offer, in the docs. For example the page https://docs.cloudfoundry.org/devguide/deploy-apps/routes-domains.html#domains-dns would be easier to comprehend for new users if it included a specific example (e.g. "cfapps.io" for PWS or "scapp.io" for Swisscom) instead of using the generic ".shared-domain.com". I would therefore vote to create a new variable shared_domain in config.yml and use it everywhere instead of examples like "shared-domain.com". The Cloud Foundry docs could still set that variable to "shared-domain.com" to stay generic.

If you guys agree, I can make a PR.

Took me a bit of Googling to find this repository...would be useful to have a link to "edit this on GitHub" for pages within http://docs.cloudfoundry.org.

Hey there,

We noticed that the Contributing Pull Requests section of the README could be updated to better explain newer functionality that bookbinder provides. I've listed steps below (originally penned by @shalako) that may make it easier for others to make changes to the documentation.

1. fork the content repo you want to make a contribution to

   Examples:
   The docs that describes buildpacks can be found at http://docs.cloudfoundry.org/buildpacks/index.html. The content repo is: https://github.com/cloudfoundry/docs-buildpacks
   The docs that describes for users how to push apps, create service instances, etc. can be found at: http://docs.cloudfoundry.org/devguide/services/. The content repo is: https://github.com/cloudfoundry/docs-dev-guide

2. clone your fork of the content repo

3. cd into book-repo and run $ bin/bookbinder watch
   

4. point your browser at localhost:4567
   

5. Make your edits; on save your browser page will reload with changes
   

6. commit changes, rebase from upstream, and push to your fork
   

7. Submit a PR from your fork to the original repos
   

8. The Docs team merges the PR
   

9. The Docs team pushes the book apps to production
   

Thanks for your help!

Page last updated: Invalid Date NaN, NaN

Examples:

• http://docs.cloudfoundry.org/deploying/common/consul-security.html
• http://docs.cloudfoundry.org/concepts/high-availability.html