[doc] No end-user documentation on user messages

Bug #1796986 reported by Goutham Pacha Ravi
18
This bug affects 3 people
Affects Status Importance Assigned to Milestone
OpenStack Shared File Systems Service (Manila)
High
Soledad Kuczala
python-manilaclient
Undecided
Soledad Kuczala

Bug Description

Manila's user messages feature was added in Pike [1] but there is no end-user documentation for this feature. I'm mostly interested in the CLI reference at least to specify that such a feature exists.

Relevant Developer Doc [2] has some information for manila developers
User Doc [3] has nothing pertaining to Messages
CLI Reference [4] has nothing pertaining to Messages

[1] https://docs.openstack.org/releasenotes/manila/pike.html
[2] https://docs.openstack.org/manila/latest/contributor/user_messages.html
[3] https://docs.openstack.org/manila/latest/user/create-and-manage-shares.html
[4] https://docs.openstack.org/manila/latest/cli/manila.html

Revision history for this message
Dustin Schoenbrun (dschoenb) wrote :

Yikes, we really need to get these docs added as soon as we can. Marking the bugs on manila and python-manilaclient as triaged and will query for volunteers in the next upstream meeting.

Changed in manila:
status: New → Triaged
Changed in python-manilaclient:
status: New → Triaged
Changed in manila:
importance: Undecided → High
Changed in python-manilaclient:
importance: Undecided → High
tags: added: low-hanging-fruit
Revision history for this message
Kaaira Gupta (kaaira) wrote :

hi! i want to work on this bug. But am preoccupied with university exams for 3 more days, ie till 25th feb. can i start working on this issue please?

Revision history for this message
Tom Barron (tpb) wrote :

Sure thing, please assign the bug to yourself, and thanks for the help.

Soledad Kuczala (solkz)
Changed in manila:
assignee: nobody → Soledad Kuczala (solkz)
Changed in python-manilaclient:
assignee: nobody → Soledad Kuczala (solkz)
Ogu chinedu (spockula)
Changed in manila:
assignee: Soledad Kuczala (solkz) → Ogu chinedu (spockula)
summary: - [doc] No documentation on user messages
+ [doc] No end-user documentation on user messages
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to manila (master)

Fix proposed to branch: master
Review: https://review.openstack.org/645010

Changed in manila:
assignee: Ogu chinedu (spockula) → Soledad Kuczala (solkz)
status: Triaged → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Change abandoned on manila (master)

Change abandoned by Soledad Kuczala (<email address hidden>) on branch: master
Review: https://review.openstack.org/645010
Reason: I'm going to upload it again

Tom Barron (tpb)
tags: added: doc
Revision history for this message
Jason Grosso (jgrosso) wrote :

Soledad where you able to upload the changes again?

Revision history for this message
Soledad Kuczala (solkz) wrote :

Jason Yes!, here: https://review.opendev.org/#/c/645010/
I'm going to update it ASAP

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to manila (master)

Reviewed: https://review.opendev.org/645010
Committed: https://git.openstack.org/cgit/openstack/manila/commit/?id=84e7f4e5426fcee5941b8e4cb6d53040be8cd0ee
Submitter: Zuul
Branch: master

commit 84e7f4e5426fcee5941b8e4cb6d53040be8cd0ee
Author: SolKuczala <email address hidden>
Date: Wed Mar 20 20:56:09 2019 +0000

    Adding documentation for User Messages in Manila Documentation

    -Reference to the User Messages CLI usage at:
    https://docs.openstack.org/manila/latest/cli/manila.html
    https://docs.openstack.org/manila/latest/user/create-and-manage-shares.

    Closes-Bug: #1796986
    Change-Id: Ia85736693d7f536766e0e0980f88805c61aa8325

Changed in manila:
status: In Progress → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to manila (stable/stein)

Fix proposed to branch: stable/stein
Review: https://review.opendev.org/667764

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to manila (stable/stein)

Reviewed: https://review.opendev.org/667764
Committed: https://git.openstack.org/cgit/openstack/manila/commit/?id=bf829be9999c97acd260bbc16aa4e6a921637886
Submitter: Zuul
Branch: stable/stein

commit bf829be9999c97acd260bbc16aa4e6a921637886
Author: SolKuczala <email address hidden>
Date: Wed Mar 20 20:56:09 2019 +0000

    Adding documentation for User Messages in Manila Documentation

    -Reference to the User Messages CLI usage at:
    https://docs.openstack.org/manila/latest/cli/manila.html
    https://docs.openstack.org/manila/latest/user/create-and-manage-shares.

    Closes-Bug: #1796986
    Change-Id: Ia85736693d7f536766e0e0980f88805c61aa8325
    (cherry picked from commit 84e7f4e5426fcee5941b8e4cb6d53040be8cd0ee)

tags: added: in-stable-stein
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/manila 8.0.1

This issue was fixed in the openstack/manila 8.0.1 release.

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/manila 9.0.0.0rc1

This issue was fixed in the openstack/manila 9.0.0.0rc1 release candidate.

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to manila (stable/rocky)

Fix proposed to branch: stable/rocky
Review: https://review.opendev.org/689605

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to manila (stable/rocky)

Reviewed: https://review.opendev.org/689605
Committed: https://git.openstack.org/cgit/openstack/manila/commit/?id=c6e2e4ec7334ef0161d7ada9859f9e7ca6b06659
Submitter: Zuul
Branch: stable/rocky

commit c6e2e4ec7334ef0161d7ada9859f9e7ca6b06659
Author: SolKuczala <email address hidden>
Date: Wed Mar 20 20:56:09 2019 +0000

    Adding documentation for User Messages in Manila Documentation

    -Reference to the User Messages CLI usage at:
    https://docs.openstack.org/manila/latest/cli/manila.html
    https://docs.openstack.org/manila/latest/user/create-and-manage-shares.

    Closes-Bug: #1796986
    Change-Id: Ia85736693d7f536766e0e0980f88805c61aa8325
    (cherry picked from commit 84e7f4e5426fcee5941b8e4cb6d53040be8cd0ee)
    (cherry picked from commit bf829be9999c97acd260bbc16aa4e6a921637886)

tags: added: in-stable-rocky
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to manila (stable/queens)

Fix proposed to branch: stable/queens
Review: https://review.opendev.org/690599

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to manila (stable/queens)

Reviewed: https://review.opendev.org/690599
Committed: https://git.openstack.org/cgit/openstack/manila/commit/?id=b72b45d10a578c0a95d3c46ef7faa158375962f0
Submitter: Zuul
Branch: stable/queens

commit b72b45d10a578c0a95d3c46ef7faa158375962f0
Author: SolKuczala <email address hidden>
Date: Wed Mar 20 20:56:09 2019 +0000

    Adding documentation for User Messages in Manila Documentation

    -Reference to the User Messages CLI usage at:
    https://docs.openstack.org/manila/latest/cli/manila.html
    https://docs.openstack.org/manila/latest/user/create-and-manage-shares.

    Closes-Bug: #1796986
    Change-Id: Ia85736693d7f536766e0e0980f88805c61aa8325
    (cherry picked from commit 84e7f4e5426fcee5941b8e4cb6d53040be8cd0ee)
    (cherry picked from commit bf829be9999c97acd260bbc16aa4e6a921637886)
    (cherry picked from commit c6e2e4ec7334ef0161d7ada9859f9e7ca6b06659)

tags: added: in-stable-queens
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/manila 6.3.2

This issue was fixed in the openstack/manila 6.3.2 release.

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/manila 7.4.0

This issue was fixed in the openstack/manila 7.4.0 release.

Changed in python-manilaclient:
status: Triaged → Invalid
importance: High → Undecided
To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Duplicates of this bug

Other bug subscribers