Skip to content

Add support for value in documentation - #2167

Open
stevengoossensB wants to merge 24 commits into
elastic:mainfrom
stevengoossensB:main
Open

Add support for value in documentation#2167
stevengoossensB wants to merge 24 commits into
elastic:mainfrom
stevengoossensB:main

Conversation

@stevengoossensB

Copy link
Copy Markdown

Update exported_fields.go - Add capability to write the value of a field as defined in the fields.yml to the Markdown documentation

Update exported_fields.go - Add capability to write the value of a field as defined in the fields.yml to the Markdown documentation
@jsoriano

Copy link
Copy Markdown
Contributor

/test

Comment thread internal/docs/exported_fields.go
@stevengoossensB

Copy link
Copy Markdown
Author

I added to to PR the following:

  • Example key to be added to the documentation
  • a requirement for the specVersion to be 3.2.3.
  • If example or value is nowhere defined in the fields, this also doesn't get added to the README.

@jsoriano jsoriano left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks! This approach looks better to me, I have added some questions and suggestions, let me know what you think.

Comment thread internal/docs/exported_fields.go Outdated
Comment thread internal/docs/exported_fields.go
Comment thread internal/docs/exported_fields.go
Comment thread internal/docs/exported_fields.go Outdated
Comment thread internal/docs/exported_fields.go Outdated
@jsoriano

Copy link
Copy Markdown
Contributor

/test

@jsoriano

Copy link
Copy Markdown
Contributor

@stevengoossensB CI is failing for some formatting issue. Try running make check-static and committing the changes.

@jsoriano

Copy link
Copy Markdown
Contributor

/test

@stevengoossensB
stevengoossensB requested a review from a team as a code owner November 18, 2024 13:09
@jsoriano

Copy link
Copy Markdown
Contributor

/test

@stevengoossensB

Copy link
Copy Markdown
Author

@jsoriano can you elaborate on why the tests are still failing as I don't have visibility on that.

@jsoriano

Copy link
Copy Markdown
Contributor

@jsoriano can you elaborate on why the tests are still failing as I don't have visibility on that.

It looks like the change from spec 1.0.0 to 3.4.0 in the nginx package is triggering many validation issues. You can see them with:

go run . build -v -C ./test/packages/parallel/nginx/

I would suggest to test this with some test package that is already using a 3.X spec version. For example try increasing the format_spec to 3.4.0 in the test/packages/parallel/ti_anomali package, and run:

go run . changelog add -C test/packages/parallel/ti_anomali --link https://github.com/elastic/elastic-package/pull/2167 --description "Update format spec to 3.4.0" --version 1.23.0-rc1 --type enhancement
go run . build -v -C ./test/packages/parallel/ti_anomali/

And commit the changes.

@stevengoossensB

Copy link
Copy Markdown
Author

I reverted the changes for NGINX and upgraded Anomali.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

3 participants