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

Docs(script): Application session script #5908

Merged
merged 1 commit into from
Aug 29, 2023

Conversation

Milton-Ch
Copy link
Contributor

Prepare


Description

  • Added docs for application session script

closes #4704

@mo-auto mo-auto added the area-documentation Documentation needs to change as part of issue or PR label Aug 24, 2023
@Milton-Ch Milton-Ch marked this pull request as ready for review August 25, 2023 02:00
Signed-off-by: Milton Ch. <j.milton.chambi.m@gmail.com>
@Milton-Ch Milton-Ch force-pushed the docs/application-session-script branch from eb60023 to 9d48b63 Compare August 25, 2023 17:05
Copy link
Member

@moabu moabu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ossdhaval
Copy link
Contributor

ossdhaval commented Aug 29, 2023

@moabu

As far as I can remember, we had decided to keep the actual scripts (.java, .py) out of the navigation under docs/script-catalog and to keep only the documentation about those scripts in the navigation under docs/admin/developer/scripts.

Under docs/script-catalog, there are README.md at two levels.
One at the script type level, for instance at docs/script-catalog/introspection level(call it L1), and the other at a more granular level, for instance at docs/script-catalog/introspection/introspection-custom-parameters level(call it L2).

If there is content in the README at L1, then it should be moved under the corresponding document at docs/admin/developer/scritps so that it is part of the navigation. If there is content at L2, then it should be left as it is since that content is for a specific implementation of that script type.

I believe this was the idea when we removed the script-catalog from navigation long back. Please let me know if I am wrong.

@ossdhaval ossdhaval merged commit 48452fd into main Aug 29, 2023
@ossdhaval ossdhaval deleted the docs/application-session-script branch August 29, 2023 10:25
devrimyatar pushed a commit that referenced this pull request Dec 30, 2023
Signed-off-by: Milton Ch. <j.milton.chambi.m@gmail.com>
Signed-off-by: Mustafa Baser <mbaser@mail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-documentation Documentation needs to change as part of issue or PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs(scripts): Create documentation for the Application Session script
4 participants