NASL documentation rework #1194
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Kraemii
force-pushed
the
documentation-rework
branch
from
c4b0582
to
7043615
Compare
ArnoStiefvater
force-pushed
the
documentation-rework
branch
from
7043615
to
b9a1b27
Compare
|
We should add the documentation to https://greenbone.github.io/docs/latest/index.html afterwards? |
Yes, but it will take some time (months) until the new documentation is finished. This is just the beginning of it. I would only put it into https://greenbone.github.io/docs/latest/index.html once it is finished. |
Kraemii
force-pushed
the
documentation-rework
branch
4 times, most recently
from
7c5706f
to
0f75ad1
Compare
Kraemii
force-pushed
the
documentation-rework
branch
from
0f75ad1
to
ea6023f
Compare
Kraemii
force-pushed
the
documentation-rework
branch
3 times, most recently
from
7ab71ca
to
c84a32a
Compare
Kraemii
force-pushed
the
documentation-rework
branch
3 times, most recently
from
a83ae51
to
477c629
Compare
Kraemii
force-pushed
the
documentation-rework
branch
from
477c629
to
b4e1411
Compare
jjnicola
reviewed
Nov 10, 2022
Kraemii
force-pushed
the
documentation-rework
branch
from
1304de1
to
39d67c5
Compare
jjnicola
requested changes
Nov 10, 2022
Kraemii
force-pushed
the
documentation-rework
branch
from
39d67c5
to
9847bfd
Compare
jjnicola
requested changes
Nov 10, 2022
This PR introduces a documentation scheme, which has the goal to centralize the documentation of openvas, including a complete description of NASL
This PR adds tools, which allows to generate a HTML Page from the complete documentation and man pages of NASL library functions and programs within the OpenVAS project The man-pages for the nasl library can be generated with './man.sh' or 'make nasl-man' (after build). A HTML documentation can be generated with './html.sh' or 'make manual' (after build). It contains also the man pages as well as the redis documentation. In addition it contains a few discriptions of NASL built-in functions.
ArnoStiefvater
force-pushed
the
documentation-rework
branch
from
58092bb
to
999e3db
Compare
ArnoStiefvater
approved these changes
Nov 14, 2022
jjnicola
approved these changes
Nov 14, 2022
jjnicola
pushed a commit
that referenced
this pull request
Nov 16, 2022
* Initial documentation scheme This PR introduces a documentation scheme, which has the goal to centralize the documentation of openvas, including a complete description of NASL * Add: Base documentation Tools This PR adds tools, which allows to generate a HTML Page from the complete documentation and man pages of NASL library functions and programs within the OpenVAS project The man-pages for the nasl library can be generated with './man.sh' or 'make nasl-man' (after build). A HTML documentation can be generated with './html.sh' or 'make manual' (after build). It contains also the man pages as well as the redis documentation. In addition it contains a few discriptions of NASL built-in functions.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What:
A new documentation with the goal to have a complete documentation about the OpenVAS project, which is available for everyone. This PR only contains the tooling for building a HTML documentation of the OpenVAS-scanner, also containing a NASL documentation. It is also possible to generate man-pages for the built-in NASL functions. Currently only a few NASL functions are documented, but the missing ones will be added over time.
SC-614
Why:
A more centered documentation, which is available for everyone.
How:
In addition to the Doxygen documentation, it is now also possible to generate a HTML documentation, which contains useful information about the project. To build the HTML documentation call
make manual. This will generate the manual within the docs folder.To generate the man pages for the NASL built-in functions call
make nasl-manNote that pandoc is required to built those.
Checklist: