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

Fix all URL encoding in generated docs #2416

Open
mjwolf opened this issue Dec 18, 2024 · 1 comment
Open

Fix all URL encoding in generated docs #2416

mjwolf opened this issue Dec 18, 2024 · 1 comment
Assignees
Labels
bug Something isn't working

Comments

@mjwolf
Copy link
Contributor

mjwolf commented Dec 18, 2024

Description of the issue:

The URL in file.mime_type, and possibly other fields with URLs don't render correctly when generated into markdown (for example, in the integrations documentation).

ECS is using asciidoc format, which doesn't work with markdown. All URLs should be changed to remove formatting schemes, so they work in all generated languages.

It should be fixed, and search for any other cases where its incorrect. There was another previously reported similar issue: #2328

Any additional context or examples:

Image

@mjwolf mjwolf added the bug Something isn't working label Dec 18, 2024
@mjwolf mjwolf changed the title Incorrect URL formatting in filetype.mimetype Fix all URL encoding in generated docs Dec 18, 2024
@taylor-swanson
Copy link
Contributor

Here are the other fields that have issues:

  • elf.go_import_hash
  • macho.go_import_hash
  • pe.go_import_hash
  • vulnerability.category
  • vulnerability.description
  • vulnerability.id

I talked with the docs team about it and they are good with using the URL directly in descriptions (the threat fields are a good example of this). For reference, the ECS docs site uses asciidoc, the integrations docs site uses the README markdown and parses it to asciidoc (which means the markdown must be valid), and the integrations readme/kibana uses markdown directly.

I did a grep for http in the schemas and while we're at it, we should also update http links to https. Namely references to http://publicsuffix.org.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants