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

Document preview services #1345

Merged
merged 5 commits into from
May 27, 2015
Merged

Document preview services #1345

merged 5 commits into from
May 27, 2015

Conversation

jamesls
Copy link
Member

@jamesls jamesls commented May 27, 2015

This changes the behavior of documentation, help commands, and preview services.

  • Always generate html docs for preview services. Before, if a service was marked preview the html docs were never generated.
  • Any preview service documentation now has a "this is a preview service" disclaimer added to the description.
  • You don't need to opt into the preview in order to see docs. Before something like aws cloudfront help would still require you to opt into the preview. Now, only the actual service commands require you to opt in.

Because of the way our doc system works, it's easy to add to the end of the description, but not so easy to add to the beginning of the documentation. Here's how this looks like with this change:

screen shot 2015-05-26 at 6 22 27 pm

cc @kyleknap

We only care when a user tries to make a service call that
they've opted into the preview service.  They should be able
to view docs without opting in.
command_table[preview_service] = preview_cls(
cli_name=original_command.name,
session=session,
service_name=original_command._service_name,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you would would be able to get this from original_command.service_model.service_name

@kyleknap
Copy link
Contributor

Implementation looks good. Had a few minor comments. 🚢

@jamesls
Copy link
Member Author

jamesls commented May 27, 2015

@kyleknap feedback incorporated, please take another look.

@kyleknap
Copy link
Contributor

Thanks. 🚢

@jamesls jamesls merged commit 9ef28c0 into aws:develop May 27, 2015
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

Successfully merging this pull request may close these issues.

2 participants