ovh-angular-doc-url
v0.0.7
Published
Easily create links or get urls to 2api endpoint which redirects to documentation systems
Downloads
6
Keywords
Readme
ovh-angular-doc-url
Easily create links or get urls to 2api endpoint which redirects to documentation systems (Content manager and docs.ovh.com)
Examples
Content Manager
<ovh-doc-url doc-id="g1769.creating_ssh_keys">My link</ovh-doc-url>
ovhDocUrl.getDocUrl("g1769.creating_ssh_keys")
docs.ovh.com
<ovh-doc-url doc-id="cloud/dedicated/ovh-ssh-key">My link</ovh-doc-url>
ovhDocUrl.getDocUrl("cloud/dedicated/ovh-ssh-key")
Bower
bower install ovh-angular-doc-url --save
NPM
npm install ovh-angular-doc-url --save
Get the sources
git clone https://github.com/ovh-ux/ovh-angular-doc-url.git
cd ovh-angular-doc-url
npm install
bower install
You've developed a new cool feature? Fixed an annoying bug? We'd be happy to hear from you!
Have a look in CONTRIBUTING.md
Then inject actionsMenu module in your module declaration:
angular.module("myModule", [
...
"ovh-angular-doc-url",
...
]);
Getting Started
In your web page:
<script src="angular.js"></script>
<script src="dist/ovh-angular-doc-urls"></script>
User locale configuration
.config((TranslateServiceProvider, ovhDocUrlProvider) => {
ovhDocUrlProvider.setUserLocale(TranslateServiceProvider.getUserLocale());
});
Url prefix for 2api
.config((TranslateServiceProvider, ovhDocUrlProvider) => {
ovhDocUrlProvider.setUrlPrefix("/engine/2api");
});
Related links
- Contribute: https://github.com/ovh-ux/ovh-angular-doc-url/blob/master/CONTRIBUTING.md
- Report bugs: https://github.com/ovh-ux/ovh-angular-doc-url/issues
- Get latest version: https://github.com/ovh-ux/ovh-angular-doc-url
License
See https://github.com/ovh-ux/ovh-angular-doc-url/blob/master/LICENSE