-
Notifications
You must be signed in to change notification settings - Fork 239
Update README.md #1934
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
base: main
Are you sure you want to change the base?
Update README.md #1934
Conversation
Rearranged few sections and added a new section - Config File Best Practices
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.
Pull Request Overview
This PR reorganizes the README.md file structure and adds a new "Config File Best Practices" section to improve documentation clarity. The changes move the "Download Blobfuse2" section to the top, relocate limitations and recommendations sections to the bottom, and provide guidance on proper configuration of Azure Storage account types.
- Moved "Download Blobfuse2" section earlier in the document for better visibility
- Relocated "Limitations in Block Cache" and "Recommendations in Block Cache" sections to appear after the main configuration content
- Added new "Config File Best Practices" section with guidance on Azure Storage account type configuration
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Moved most of the sections to wiki and added links of wiki to section headings
| - Attribute cache options | ||
| * `--attr-cache-timeout=<TIMEOUT IN SECONDS>`: The timeout for the attribute cache entries. | ||
| * `--no-symlinks=false`: By default symlinks will be supported and the performance overhead, that earlier existed, has been resolved. | ||
| - Storage options |
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.
Can you talk to Daniel, he has sort of automated this with the command help so that any new option we add, get automatically added to the documentation part.
|
@p15nishatr please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.
Contributor License AgreementContribution License AgreementThis Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
|
Rearranged few sections and added a new section - Config File Best Practices
Type of Change
Description
How Has This Been Tested?
Checklist
Related Links