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

GitFS online documentation is missing a section present in the code #36475

Closed
amendlik opened this issue Sep 21, 2016 · 2 comments
Closed

GitFS online documentation is missing a section present in the code #36475

amendlik opened this issue Sep 21, 2016 · 2 comments
Assignees
Labels
Bug broken, incorrect, or confusing behavior Confirmed Salt engineer has confirmed bug/feature - often including a MCVE Documentation Relates to Salt documentation fixed-pls-verify fix is linked, bug author to confirm fix P1 Priority 1 severity-low 4th level, cosemtic problems, work around exists
Milestone

Comments

@amendlik
Copy link
Contributor

Description of Issue/Question

There is a section of documentation in the code that does not appear in the online documentation.
The code is here:
https://github.com/saltstack/salt/blame/b4a28e2684e91dda7e326efa957507e852c90436/doc/topics/tutorials/gitfs.rst#L781-L786

Using the GitHub RST parser, that section appears:
https://github.com/saltstack/salt/blob/b4a28e2684e91dda7e326efa957507e852c90436/doc/topics/tutorials/gitfs.rst#refreshing-gitfs-upon-push

But it is missing in the SaltStack online documentation:
https://docs.saltstack.com/en/latest/topics/tutorials/gitfs.html#refreshing-gitfs-upon-push

@gtmanfred gtmanfred added Documentation Relates to Salt documentation Question The issue is more of a question rather than a bug or a feature request Confirmed Salt engineer has confirmed bug/feature - often including a MCVE labels Sep 21, 2016
@gtmanfred gtmanfred added this to the Approved milestone Sep 21, 2016
@gtmanfred
Copy link
Contributor

Yup, it looks like that is not there in develop either.

Thanks for reporting this.

@rallytime
Copy link
Contributor

This is caused by this error here, when building the docs:

/root/SaltStack/salt/doc/topics/tutorials/gitfs.rst:918: ERROR: Error in "code-block" directive:
1 argument(s) required, 0 supplied.

.. code-block::

    Cmnd_Alias SALT_GIT_HOOK = /bin/salt-call event.fire_master update salt/fileserver/gitfs/update
    Defaults!SALT_GIT_HOOK !requiretty
    ALL ALL=(root) NOPASSWD: SALT_GIT_HOOK

And is fixed by added a bash option in the .. code-block:: line. This is fixed in #36478.

Thanks for letting us know @amendlik!

@rallytime rallytime added Bug broken, incorrect, or confusing behavior severity-low 4th level, cosemtic problems, work around exists P1 Priority 1 TEAM Core fixed-pls-verify fix is linked, bug author to confirm fix and removed Question The issue is more of a question rather than a bug or a feature request labels Sep 21, 2016
@rallytime rallytime modified the milestones: C 3, Approved Sep 21, 2016
@rallytime rallytime self-assigned this Sep 21, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug broken, incorrect, or confusing behavior Confirmed Salt engineer has confirmed bug/feature - often including a MCVE Documentation Relates to Salt documentation fixed-pls-verify fix is linked, bug author to confirm fix P1 Priority 1 severity-low 4th level, cosemtic problems, work around exists
Projects
None yet
Development

No branches or pull requests

3 participants