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

Add post install notes #163

Merged
merged 1 commit into from
May 8, 2015
Merged

Add post install notes #163

merged 1 commit into from
May 8, 2015

Conversation

jsancio
Copy link
Contributor

@jsancio jsancio commented May 8, 2015

No description provided.

if post_install_notes:
# Let's use errors.DefaultError for now because that is currently the
# only way to print messages to stderr
emitter.publish(errors.DefaultError(post_install_notes))
Copy link
Contributor

Choose a reason for hiding this comment

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

why should we print this to stderr?

Copy link
Contributor

Choose a reason for hiding this comment

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

We need to work on documentation. postInstallNotes is in the universe example, but we don't actually document these properties anywhere.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

why should we print this to stderr?

Done.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We need to work on documentation. postInstallNotes is in the universe example, but we don't actually document these properties anywhere.

Yes. We have a lot of information in different places but we do need to improve our user experience.

@@ -594,7 +595,10 @@ def _install_mesos_dns(
args=['--options=tests/data/package/mesos-dns-config.json'],
returncode=0,
stdout=b'Installing package [mesos-dns] version [alpha]\n',
stderr=b''):
stderr=b'',
postInstallNotes=b'Please refer to the tutorial instructions for '
Copy link
Contributor

Choose a reason for hiding this comment

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

why not just append this to stdout?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We overwrite the stdout parameter in a few places. I didn't want to copy that string everywhere. See: https://github.com/mesosphere/dcos-cli/blob/dcos-611-post-install/cli/tests/integrations/cli/test_package.py#L335

Copy link
Contributor

Choose a reason for hiding this comment

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

good point

mgummelt added a commit that referenced this pull request May 8, 2015
@mgummelt mgummelt merged commit ab03186 into master May 8, 2015
@mgummelt mgummelt deleted the dcos-611-post-install branch May 8, 2015 17:49
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