[GitHub] [apisix] yzeng25 opened a new pull request, #6947: docs: fix description format in mocking doc

[GitBox <gi...@apache.org>]

yzeng25 opened a new pull request, #6947:
URL: https://github.com/apache/apisix/pull/6947

   ### Description
   
   <!-- Please include a summary of the change and which issue is fixed. -->
   <!-- Please also include relevant motivation and context. -->
   
   ## Issue
   I encountered a "Test and deploy" CI check failure in https://github.com/apache/apisix-website/pull/1059. While preview works as expected, the check failed for the following reason.
   ```
   Error while parsing Markdown frontmatter.
   This can happen if you use special characters in frontmatter values (try using double quotes around that value).
   Can't process doc metadatas for doc at path "/home/runner/work/apisix-website/apisix-website/website/i18n/zh/docusaurus-plugin-content-docs-docs-apisix/current/plugins/mocking.md" in version "current"
   Loading of version failed for version "current"
   Unable to build website for locale "zh".
   YAMLException: bad indentation of a mapping entry at line 8, column 3:
         description: 本文介绍了关于 Apache APIS ... 
   ```
   
   ## Locating the problem
    I did not change anything in `docusaurus-plugin-content-docs-docs-apisix/current/plugins/mocking.md`, so this is likely to be a mistake previously made. Thanks to https://github.com/apache/apisix-website/pull/1059#issuecomment-1110586516 pointing out the problem.
   
   So then the problem is located in `docusaurus-plugin-content-docs-docs-apisix/current/plugins/mocking.md`, and it indicated the `description` part in `plugins/mocking.md` file is likely to have some kind of format issue.
   
   After checking, I find an indentation issue in `plugins/mocking.md` in the master branch. Extra indentation is presented in front of `description`.
   
   ```
   ---
   title: mocking
   keywords:
     - APISIX
     - Plugin
     - Mocking
     - mocking
     description: 本文介绍了关于 Apache APISIX `mocking` 插件的基本信息及使用方法。
   ---
   ```
   
   So we need to remove the indentation.
   
   ## Why we need this fix
   
   1. It is a formatting problem, wen should fix it though it is very tiny.
   2. It is blocking my pull request in another repo, and potentially other pull requests that changes blog contents in the future. So I think it is better to fix it before it creates too many troubles.
   
   ### Checklist
   
   - [x] I have explained the need for this PR and the problem it solves
   - [x] I have explained the changes or the new features added to this PR
   - [ ] I have added tests corresponding to this change
   - [x] I have updated the documentation to reflect this change
   - [ ] I have verified that this change is backward compatible (If not, please discuss on the [APISIX mailing list](https://github.com/apache/apisix/tree/master#community) first)
   
   <!--
   
   Note
   
   1. Mark the PR as draft until it's ready to be reviewed.
   3. Always add/update tests for any changes unless you have a good reason.
   4. Always update the documentation to reflect the changes made in the PR.
   5. Make a new commit to resolve conversations instead of `push -f`.
   6. To resolve merge conflicts, merge master instead of rebasing.
   7. Use "request review" to notify the reviewer after making changes.
   8. Only a reviewer can mark a conversation as resolved.
   
   -->
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [apisix] spacewander merged pull request #6947: docs: fix description format in mocking doc

[GitBox <gi...@apache.org>]

spacewander merged PR #6947:
URL: https://github.com/apache/apisix/pull/6947


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org