Make bash autocomplete instructions easier to find #556

Open Cynical-Optimist opened 4 years ago

See original issue on GitLab In GitLab by [Gitlab user @Qinusty] on Aug 6, 2018, 11:17

Background

Buildstream autocompletion instructions are quite deep within the install documentation.

Task description

[ ] Make instructions easier to find either by moving or linking to from elsewhere.

Acceptance Criteria

Autocomplete instructions should be easy to find for newcomers to the project.

In GitLab by [Gitlab user @tristanvb] on Aug 6, 2018, 11:21

It appears that the install guide has evolved in such a way that the bash completion steps are hard to find.

Would you like to repurpose this issue into a documentation issue ?

In GitLab by [Gitlab user @Qinusty] on Aug 6, 2018, 11:39

changed title from {-Terminal autocompletion for buildstream-} to {+Make bash autocomplete instructions easier to find+}

In GitLab by [Gitlab user @Qinusty] on Aug 6, 2018, 11:39

changed the description

In GitLab by [Gitlab user @Qinusty] on Aug 6, 2018, 11:40

Regarding the lack of autocompletion support for other shells, should these be raised as separate tickets?

[ ] Fish
[ ] Zsh

In GitLab by [Gitlab user @tristanvb] on Aug 6, 2018, 11:43

Regarding the lack of autocompletion support for other shells, should these be raised as separate tickets?

Yes they should (this will let us treat them separately and close the appropriate issue when one of them is implemented). Please mark them as related.

In GitLab by [Gitlab user @Qinusty] on Aug 6, 2018, 13:23

marked this issue as related to #558

In GitLab by [Gitlab user @Qinusty] on Aug 6, 2018, 13:23

marked this issue as related to #557

In GitLab by [Gitlab user @jennis] on Aug 9, 2018, 09:57

[Gitlab user @Qinusty], I agree, I think we need to move the 'BASH completions' section so that it is no longer living under the "Installing from source" section.

What did you have in mind?

I would like to contribute my own thoughts on this. I think we need only make a minor modification to the install_linux_distro.rst file to have the following sections:

Installing BuildStream on a Linux distro
========================================

Installing from source (recommended)
------------------------------------

Installing from distro packages
-------------------------------

Enabling auto-completion
------------------------

Thoughts?

buildstream-migration / bst-staging