Skip to content

Clean up markdown in spec #2746

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

Merged
merged 2 commits into from
Jul 30, 2024
Merged

Clean up markdown in spec #2746

merged 2 commits into from
Jul 30, 2024

Conversation

shainaraskas
Copy link
Contributor

@shainaraskas shainaraskas commented Jul 29, 2024

Based on feedback, we realized that certain markdown was breaking other docs sets that rely on these specifications. Removing the problematic markdown while we decide on a strategy.

holding this until I figure out whether additional markdown such as code markup and bulleted lists also break things <- will follow up on this in a later pr if needed

Copy link
Contributor

Following you can find the validation results for the APIs you have changed.

API Status Request Response
cat.aliases 🟢 30/30 30/30
cat.component_templates Missing test Missing test
cat.count 🟢 9/9 9/9
cat.indices 🔴 35/35 24/34
cat.ml_data_frame_analytics 🟢 5/5 5/5
cat.ml_datafeeds 🟢 4/4 4/4
cat.ml_jobs 🟢 4/4 4/4
cat.ml_trained_models 🟢 1/1 1/1
cat.transforms 🟢 7/7 7/7

You can validate these APIs yourself by using the make validate target.

Copy link
Member

@pquentin pquentin left a comment

Choose a reason for hiding this comment

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

Thanks! Great step in the right direction for now.

Can you please tell us which APIs have bullet point or code samples?

@shainaraskas shainaraskas marked this pull request as ready for review July 30, 2024 14:37
Copy link

@kilfoyle kilfoyle left a comment

Choose a reason for hiding this comment

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

LGTM! 🦕

@shainaraskas shainaraskas merged commit c44074f into main Jul 30, 2024
9 checks passed
@shainaraskas shainaraskas deleted the clean-up-markdown branch July 30, 2024 14:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants