-
Notifications
You must be signed in to change notification settings - Fork 30
Add to Migration, Syntax, and Contribution Guides #170
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
Conversation
@@ -0,0 +1,59 @@ | |||
import re |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@elastic/docs-engineering I wonder if there's somewhere better to put these scripts instead of in the docs dir? A consideration is that some of these scripts output .md
files that are included in the docs.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@bmorelli25 can you describe a bit what the intended use case is for these ?
Who runs them and when? is this a continuous thing?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good question. They're documented in the source files in this PR. But a brief summary is:
-
CODEOWNER list for documentation freeze
This script creates a list of repositories and the directories in those repositories that the@docs-freeze-team
(just @KOTungseth) should be added as codeowner of. During a documentation freeze, the@docs-freeze-team
must approve any pull requests that modify.asciidoc
files before they can be merged. This prevents folks from merging docs changes during the freeze. -
Attribute converter
This script converts the attributes in https://github.com/elastic/docs/blob/master/shared/attributes.asciidoc to the supported yaml format for docs-builder.
1. HTML to Markdown Tab Converter
The tab converter script is used to convert HTML tabs into Markdown tabs within documentation files. The script scans through specified directories, finds all Markdown ( This is no longer necessary as @siamakp-elastic added this capability to the migration tool. I've removed this script from this PR..md
) files, and replaces any HTML-based tab structures with their Markdown equivalents.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
-
Is this something that needs to run continuously in the future or is this a one of thing?
-
Same question really, but also:
- Do we need all of these in the new architecture?
- Rather then having these live in all of the isolated
docset.yml
files shoulddocs-builder
natively support them?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this something that needs to run continuously in the future or is this a one of thing?
Okay so after a meeting today, the CODEOWNER script won't be used so we can get rid of it. We will need to rerun the attribute converter eventually (Jan 29) but I can do that so there's no need to put it here (won't be used after that date). I'll remove both from this PR.
Do we need all of these in the new architecture?
All, no. Most, yes.
Rather then having these live in all of the isolated docset.yml files should docs-builder natively support them?
Yes. The more I play with this, the more a single yml file where these can be defined would be ideal.
The build is currently failing with
Opened a bug for this: #169 |
As discussed above, I removed the scripts from this PR. That also fixed the build error. I'm going to get this merged so that the GH pages is updated. |
Summary