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 installation hint for released packages #121

Open
gavanderhoorn opened this issue Mar 4, 2015 · 9 comments
Open

Add installation hint for released packages #121

gavanderhoorn opened this issue Mar 4, 2015 · 9 comments

Comments

@gavanderhoorn
Copy link
Contributor

From clarifying package installation 'best practices'? on ros-users.

I suggest we add automatically generated installation hints to wiki pages of released packages, in order to reduce the number of users that install everything from source (perhaps inspired by the Source link under the Package Summary heading).

@gavanderhoorn
Copy link
Contributor Author

Some mockups (I'm not a web designer):

Extra li below Source

common_msgs_install_hint_ul_li_sshot


Extra section

common_msgs_install_hint_install_section_sshot

The rpm line was more of a test. Afaict there is no way to deduce this from the info in the manifest.yaml files.


Split up package-info <p>

common_msgs_install_hint_install_section2_sshot

@jbohren
Copy link

jbohren commented Mar 4, 2015

What's the official pattern for converting a ros package name / distro into a debian package name?

Is it just the following?

"ros-%s-%s" % (distro, pkg_name.replace('_', '-'))

@dirk-thomas
Copy link
Member

Yes.

@gavanderhoorn
Copy link
Contributor Author

This is from bloom/rosdebian.py:

def rosify_package_name(name, rosdistro):
    return 'ros-{0}-{1}'.format(rosdistro, name)

The names in those mockups are actually from the manifest.yaml file that @dirk-thomas linked.

@tfoote
Copy link
Member

tfoote commented Mar 4, 2015

We should definitely consider needing to extend this to the RPM case. We are very close thanks to @cottsay

I like the last mockup the best. We should make sure to link to the installation instructions: http://wiki.ros.org/indigo/Installation/Ubuntu in that to know that they will have to add apt-sources etc.

We may need to consider adding some info to the manifest to specifcally call out which packages are availailable since we don't want to tell people to install via apt if it's not built.

@tfoote
Copy link
Member

tfoote commented Mar 4, 2015

Related to this we could also consider giving the matrix of versions available in shadow-fixed and public. aka the info here: http://www.ros.org/debbuild/indigo.html?q=roscpp_tutorials

@gavanderhoorn
Copy link
Contributor Author

We may need to consider adding some info to the manifest to specifcally call out which packages are availailable since we don't want to tell people to install via apt if it's not built.

All info shown (apart from the rpm line) can be extracted from the manifest.yaml files that the macro has access to. I was thinking of using the release_jobs entry for figuring out whether something's been released (or is_stack_released() in headers.py).

@gavanderhoorn
Copy link
Contributor Author

First attempt pushed to gavanderhoorn:issue121_installation_hint. Not done yet, but I'd like to get some initial feedback on approach taken if possible.

Haven't yet tested this on a local instance of the wiki. Is there any documentation on how to set up a development instance of the wiki?

Also: I think headings other than h1 automatically receive section numbering. Is there a CSS class or some other way to turn that off? Would save me from some digging.

@wjwwood
Copy link
Contributor

wjwwood commented Mar 24, 2015

@gavanderhoorn I recently used https://github.com/ros-infrastructure/roswiki_vagrant and it worked to setup an instance of the roswiki using Vagrant.

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

5 participants