Update ReadMe files after monorepo restructuring
See original GitHub issueIs your feature request related to a problem? Please describe.
After the folder restructuring, the ReadMe files need to be kept up to date as well. At the moment, the top level ReadMe also reflects the developer version instead of the marketplace version.
Describe the solution you’d like
Perhaps the new structure should be as follows:
.
│-- README.md (Top level ReadMe featured in VScode marketplace)
│
└───docs
│ │-- Developer ReadMe (Install, Build, and Test the Extension)
│ │-- README-Extending.md
│ │-- README-Security.md
│ │-- README-Theia.md
│
└───packages
│ └───eslint-plugin-zowe-explorer
│ │ │-- ZE eslint plugin ReadMe
│ │
│ └───zowe-explorer-api
│ │ │-- ZE API ReadMe
│ │
│ └───zowe-explorer-ftp-extension
│ │ │-- ZE FTP extension ReadMe
│ │
│ └───zowe-explorer
│ │-- ZE Core ReadMe
Additional context
The references to the old file structure have to be updated, too (e.g. ./resources/testProfileData.example.ts
).
Issue Analytics
- State:
- Created 3 years ago
- Comments:10 (6 by maintainers)
Top Results From Across the Web
Improve Git monorepo performance with a file system monitor
Git's new builtin file system monitor makes it easy to speed up monorepo performance.
Read more >Angular Monorepo pains. and how to overcome them - ITNEXT
A valid strategy is first renaming files using git mv, for eg. we had to rename all our backend files from .js to...
Read more >RFC: Return of the Monorepo - Developers - The Stan Forums
In some sense I am the wrong person to propose the reorganization of the source code and other directories - I really care...
Read more >www-gitlab-com - README.md
The git-page-update handbook page is the single source of truth for how to ... is currently in the process of reorganization as a...
Read more >Do I have to update project version when only README has ...
Make changes in a branch. Merge to master here and there, release a new patch version. Move the documentation (or a part of...
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
I can do the contributions to awesome-zowe
A new Doc Updates Epic was opened to track all the related issues. This issue will focus on the top level readme update