search

TwanoO67 / ngx-admin-lte

Admin LTE for Angular 2/4/6/8 as a NPM package
MIT License
109 stars 47 forks source link

Images and Font files do not belong in version control of core library #58

Open catull opened 6 years ago

catull commented 6 years ago

All the image files are really not necessary in the the core library. They have to be relocated to a DEMO project, such as Bootstrapping Ngx-Admin-Lte.

My usage of ngx-admin-lte for instance is practically image-less.

Also, there are two more issues I have with the core library.

  1. Why do we have a dependency on FontAwesome (in package.json) AND we keep a local copy in src/public/fonts AND also in docs/fonts ????
  2. Why do we check in docs files, which are clearly generated, but are not going to be used by the end user ?

Why can't the generated docs not be published to a companion web site, e.g. https://ngx-admin-lte.github.io/ ?

Both points are a waste of resources.

TwanoO67 commented 6 years ago
  1. I agree that images can be provided in the demo project

2.The companion web site for the documentation is: https://twanoo67.github.io/ngx-admin-lte/

It is based on the gh-pages branch which is a subtree of the master branch (to ease maintainance). As so it have is own dependencyes embedded as in github paged we have no access to node_modules. It could be generated by a Continuous-Integration method, and push to the github-pages branch based on the master content. But in the mean time, as we don't have that process now, it should stay here, to be abble to publish the doc. Furthermore, in v2 the "docs" folder, is in the npmignore file, so it won't be a problem for the end user.

  1. the local copy of font awesome in src/public/fonts was here to fix the fonts import resolution, and ease the installation of assets. Maybe a new solution is possible since the APF format, but we have to be sure that all sub-imports of fonts by font-awesome are still well found.
catull commented 6 years ago

All you need to do in the immediate future is to maintain a branch gh-pages with the docs/ checked in. Of course, there needs to be a clever layout in index.html that can use the docs/.

This is easily done.