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

Add support for value in documentation #2167

Open
wants to merge 24 commits into
base: main
Choose a base branch
from

Conversation

stevengoossensB
Copy link

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
Member

/test

@stevengoossensB
Copy link
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.

Copy link
Member

@jsoriano jsoriano left a comment

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.

internal/docs/exported_fields.go Outdated Show resolved Hide resolved
internal/docs/exported_fields.go Outdated Show resolved Hide resolved
internal/docs/exported_fields.go Show resolved Hide resolved
internal/docs/exported_fields.go Outdated Show resolved Hide resolved
internal/docs/exported_fields.go Outdated Show resolved Hide resolved
@jsoriano
Copy link
Member

/test

@jsoriano
Copy link
Member

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

@jsoriano
Copy link
Member

/test

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

/test

@stevengoossensB
Copy link
Author

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

@jsoriano
Copy link
Member

@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
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants