RepoMirrors/ceph
1
0
Fork 0
mirror of https://github.com/ceph/ceph synced 2025-01-11 05:29:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #27433 from rhcs-dashboard/wip-36243-master

Browse Source 
mgr/dashboard: Add frontend code documentation

Reviewed-by: Stephan Müller <smueller@suse.com>
Reviewed-by: Tatjana Dehler <tdehler@suse.com>
This commit is contained in:
Lenz Grimmer 2019-04-16 14:34:20 +02:00 committed by GitHub
commit 6a0911d130
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 2138 additions and 61 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
src/pybind/mgr/dashboard/HACKING.rst
View File

@ -65,6 +65,15 @@ Run ``npm run build`` to build the project. The build artifacts will be
stored in the ``dist/`` directory. Use the ``--prod`` flag for a
production build (``npm run build -- --prod``). Navigate to ``https://localhost:8443``.
Build the Code Documentation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Run ``npm run doc-build`` to generate code docs in the ``documentation/``
directory. To make them accesible locally for a web browser, run
``npm run doc-serve`` and they will become available at ``http://localhost:8444``.
With ``npm run compodoc -- <opts>`` you may
`fully configure it https://compodoc.app/guides/usage.html`_.
Code linting and formatting
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

2184
src/pybind/mgr/dashboard/frontend/package-lock.json generated
View File

File diff suppressed because it is too large Load Diff

6
src/pybind/mgr/dashboard/frontend/package.json
View File

@ -21,7 +21,10 @@
"fix:prettier": "prettier --write \"{src,e2e}/**/*.{ts,scss}\"",
"fix:tslint": "npm run lint:tslint -- --fix",
"fixmod": "prettier --write $(git rev-parse --show-toplevel)/$(git status --porcelain | grep -E '^(\\sM|\\?\\?|A)' | sed -e 's/^...//' | grep -E '^(src|e2e).*\\.(ts|scss)$') 1>/dev/null 2>&1 && echo 'done' || echo 'no changes found'",
"fix": "npm run fix:tslint; npm run fix:prettier"
"fix": "npm run fix:tslint; npm run fix:prettier",
"compodoc": "compodoc",
"doc-build": "compodoc -p src/tsconfig.app.json",
"doc-serve": "compodoc --port 8444 -s src/tsconfig.app.json"
},
"private": true,
"jest": {
@ -87,6 +90,7 @@
"@angular/cli": "7.3.3",
"@angular/compiler-cli": "7.2.6",
"@angular/language-service": "7.2.6",
"@compodoc/compodoc": "^1.1.9",
"@types/jasmine": "3.3.9",
"@types/jasminewd2": "2.0.6",
"@types/jest": "24.0.9",