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

JS SDK upload artifact script added for api docs #148

Merged
merged 10 commits into from
Mar 16, 2022
Merged

Conversation

bparmar-splunk
Copy link
Contributor

Update:

  • Automating zip on api-docs was successful
  • Below steps were added in release github workflow:
    • Package info action module added to read package json file from github action.
    • Docs generation and zipping section
    • Upload artifact github action module was added to upload generated api docs to action summary.

@fantavlik
Copy link
Contributor

Hi @bparmar-splunk - I just took a look at the docs generated in this run: https://github.com/splunk/splunk-sdk-javascript/actions/runs/1980485787 it seems that the formatting is not there and doesn't seem to match those generated and used here: https://docs.splunk.com/DocumentationStatic/JavaScriptSDK/1.0/splunkjs.Service.html are you able to reproduce the docs locally? Do they also have issues with formatting?

@bparmar-splunk
Copy link
Contributor Author

Hi @bparmar-splunk - I just took a look at the docs generated in this run: https://github.com/splunk/splunk-sdk-javascript/actions/runs/1980485787 it seems that the formatting is not there and doesn't seem to match those generated and used here: https://docs.splunk.com/DocumentationStatic/JavaScriptSDK/1.0/splunkjs.Service.html are you able to reproduce the docs locally? Do they also have issues with formatting?

Hi @fantavlik,
In my local, when I have downloaded docs zip there are no formatting.
Even, when we provide generated api-docs to patrick for updating JS docs on docs.splunk.com, it is also not formatted when checked in local.
The site docs.splunk.com contains all supported css and js files. Hence, it's UI looks good.

@bparmar-splunk bparmar-splunk merged commit 5152fff into develop Mar 16, 2022
@akaila-splunk akaila-splunk mentioned this pull request Jun 17, 2022
@ashah-splunk ashah-splunk deleted the DVPL-10799 branch April 20, 2023 11:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants