Skip to content

update markdownlint headers to match doc #15360

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

Closed
wants to merge 1 commit into from

Conversation

rashmi43
Copy link

@rashmi43 rashmi43 commented Jun 28, 2024

Description

Fixes: #15148

Reviewers

  • Ambient
  • [X ] Docs
  • Installation
  • Networking
  • Performance and Scalability
  • Extensions and Telemetry
  • Security
  • Test and Release
  • User Experience
  • Developer Infrastructure
  • Localization/Translation

@rashmi43 rashmi43 requested a review from a team as a code owner June 28, 2024 07:29
@istio-policy-bot
Copy link

😊 Welcome! This is either your first contribution to the Istio documentation repo, or
it's been a while since you've been here. A few things you should know:

  • You can learn about how we write and maintain documentation, our style guidelines,
    and the available web site features by visiting Contributing to the Docs.

  • In the next few minutes, an automatic preview of your change will be built with
    a full copy of the istio.io website. You can find this preview by clicking on
    the Details link next to the deploy/netlify entry in the status section of this
    page.

  • We care about quality, so we've put in place a number of checks to ensure our documentation
    is top-notch. We do spell checking, sanitize the Markdown, ensure all hyperlinks point to a
    valid location, and more. If your PR doesn't pass one of these checks, you'll see a red X in the
    lint_istio.io entry in the status section. Click on the Details link to get a list of the
    problems with your PR. Fix those problems and push an update; this will automatically re-run the
    tests. Hopefully this time everything will be perfect!

  • Once your changes are accepted and merged into the repository, they will initially show up
    on https://preliminary.istio.io. The changes will be published to https://istio.io
    the next time we do a major release (which typically happens every 3 months or so).
    To publish them sooner, add a cherrypick/release-x.xx label, where x.xx is the current
    release of Istio.

Thanks for contributing!

Courtesy of your friendly welcome wagon.

Copy link

CLA Not Signed

@istio-testing istio-testing added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Jun 28, 2024
@istio-testing
Copy link
Contributor

Hi @rashmi43. Thanks for your PR.

I'm waiting for a istio member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@craigbox
Copy link
Contributor

@rashmi43 Thanks for this, but the issue in question was asking to change the engine we use, not the configuration for the current one.

The change youve proposed would actually break every doc in istio.io, as they would all expect to start with a single # heading, where they currently start with a ## heading.

@craigbox craigbox closed this Jun 28, 2024
@rashmi43
Copy link
Author

rashmi43 commented Jun 28, 2024

thanks for your comments, how can I go about engine change?
By defining a new rule file that uses the new engine? If you can break it down for me I can try to make the engine change.

@craigbox
Copy link
Contributor

You would need to learn how the current script/build tools use the Ruby version of markdownlint, update them to package and use the Node.JS version, and then update the configuration to match our existing rules.

You may also need to do a mass update of the docs to fix any behaviour we can't configure around.

If you are interested in doing this, then consider dropping by #docs on the Istio slack.

@rashmi43
Copy link
Author

rashmi43 commented Jul 1, 2024

You would need to learn how the current script/build tools use the Ruby version of markdownlint, update them to package and use the Node.JS version, and then update the configuration to match our existing rules.

You may also need to do a mass update of the docs to fix any behaviour we can't configure around.

If you are interested in doing this, then consider dropping by #docs on the Istio slack.

sure I will take this up

@rashmi43 rashmi43 deleted the issue15148 branch July 4, 2024 16:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/docs needs-ok-to-test size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

migrate from markdownlint (ruby) to markdownlint (node JS)
4 participants