Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CF docs should remain vendor agnostic #202

Closed
cloudlena opened this issue Aug 30, 2017 · 1 comment
Closed

CF docs should remain vendor agnostic #202

cloudlena opened this issue Aug 30, 2017 · 1 comment

Comments

@cloudlena
Copy link
Contributor

cloudlena commented Aug 30, 2017

The PCF specific documentation triggered by the <% else %> statement on this line breaks my documentation build because I don't have the partial ../../customizing/c2c_pcf_logging and not even the customizing directory. Could you please change the else to something which only applies to PWS or find a more generic solution?

As a general issue, I've been seeing more and more that the official Cloud Foundry documentation contains specific PWS documentation snippets. I don't think that one vendor should fit the official Cloud Foundry docs so clearly to their needs and would therefore ask PWS developers to also think about other vendors when inserting snippets into the docs that are specific to your platform. It has happened countless times that my build has broken due to such reasons and it would, in my opinion, make much more sense if this remained a documentation exclusively for the product "Cloud Foundry" and wouldn't contain parts specific to PWS. The CF docs should remain vendor agnostic!

We have Bookbinder to combine Cloud Foundry docs and vendor specific docs easily and it should be used to do so instead of some hacky if-else statements in the official docs.

@cf-gitbot
Copy link

We have created an issue in Pivotal Tracker to manage this:

https://www.pivotaltracker.com/story/show/150664704

The labels on this github issue will be updated when the story is started.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants