Skip to content

Add URL query parameter for documentation url sharing #2

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.

Sign up for GitHub

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

Open
DavithkbY wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add URL query parameter for documentation url sharing #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion app/components/documentation.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<div class="pure-g">
<div class="pure-u-1-5">
<div class='sw-docs-menu'>
<MenuItems @docTree={{@docTree}} @level={{0}} @clickHandler={{this.changeDoc}}/>
<MenuItems @docTree={{@docTree}} @level={{0}} @clickHandler={{@onDocChange}}/>
</div>
</div>
<div class="pure-u-4-5">
Expand Down
10 changes: 3 additions & 7 deletions app/components/documentation.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,9 @@
import Component from '@glimmer/component';
import { tracked } from '@glimmer/tracking';
import { action } from '@ember/object';
import { htmlSafe } from '@ember/template';

export default class DocumentationComponent extends Component {
@tracked currentDoc = htmlSafe("<zero-md src='https://raw.githubusercontent.com/mu-semtech/mu-project/master/README.md'></zero-md>");

@action
changeDoc(url){
this.currentDoc = htmlSafe("<zero-md src='"+url+"'></zero-md>");
get currentDoc() {
const url = this.args.currentDocUrl;
return htmlSafe(`<zero-md src='${url}'></zero-md>`);
}
}
10 changes: 4 additions & 6 deletions app/components/menu-items.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
{{#each @docTree as |leaf|}}
{{#if leaf.value}}
{{#if leaf.link}}
{{this.whitespace}}<button class="tree-button" type="button" {{on "click" (fn @clickHandler leaf.value)}}>{{leaf.name}}</button><br>
{{else}}
{{this.whitespace}}{{leaf.name}}<br>
{{/if}}
{{#if leaf.link}}
{{this.whitespace}}<button class="tree-button" type="button" {{on "click" (fn @clickHandler leaf.id)}}>{{leaf.name}}</button><br>
{{else if leaf.value}}
{{this.whitespace}}{{leaf.name}}<br>
<MenuItems @docTree={{leaf.value}} @level={{this.nextLevel}} @clickHandler={{@clickHandler}}/>
{{/if}}
{{/each}}
87 changes: 64 additions & 23 deletions app/controllers/docs.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,47 @@
import Controller from '@ember/controller';
import { tracked } from '@glimmer/tracking';
import { action } from '@ember/object';

export default class DocsController extends Controller {
queryParams = ['doc'];

@tracked doc = 'project-template';

get currentDocUrl() {
return this.docLookup[this.doc] || this.docLookup['project-template'];
}

@action
changeDoc(id) {
this.doc = id;
}

docLookup = {
'project-template': 'https://raw.githubusercontent.com/mu-semtech/mu-project/master/README.md',
'identifier': 'https://raw.githubusercontent.com/mu-semtech/mu-identifier/master/README.md',
'dispatcher': 'https://raw.githubusercontent.com/mu-semtech/mu-dispatcher/master/README.md',
'authorization-new': 'https://raw.githubusercontent.com/mu-semtech/sparql-parser/master/README.md',
'authorization-old': 'https://raw.githubusercontent.com/mu-semtech/mu-authorization/master/README.md',
'delta-notifier': 'https://raw.githubusercontent.com/mu-semtech/delta-notifier/master/README.md',
'javascript-template': 'https://raw.githubusercontent.com/mu-semtech/mu-javascript-template/master/README.md',
'ruby-template': 'https://raw.githubusercontent.com/mu-semtech/mu-ruby-template/master/README.md',
'python-template': 'https://raw.githubusercontent.com/mu-semtech/mu-python-template/master/README.md',
'login-service': 'https://raw.githubusercontent.com/mu-semtech/login-service/master/README.md',
'registration-service': 'https://raw.githubusercontent.com/mu-semtech/registration-service/master/README.md',
'resources-service': 'https://raw.githubusercontent.com/mu-semtech/mu-cl-resources/master/README.md',
'file-service': 'https://raw.githubusercontent.com/mu-semtech/file-service/master/README.md',
'migrations-service': 'https://raw.githubusercontent.com/mu-semtech/mu-migrations-service/master/README.md',
'search': 'https://raw.githubusercontent.com/mu-semtech/mu-search/master/README.md',
'cache': 'https://raw.githubusercontent.com/mu-semtech/mu-cache/master/README.md',
'data-table': 'https://raw.githubusercontent.com/mu-semtech/ember-data-table/master/README.md',
'login-addon': 'https://raw.githubusercontent.com/mu-semtech/ember-mu-login/master/README.md',
'registration-addon': 'https://raw.githubusercontent.com/mu-semtech/ember-mu-registration/master/README.md',
'transform-helpers': 'https://raw.githubusercontent.com/mu-semtech/ember-mu-transform-helpers/master/README.md',
'mu-cli': 'https://raw.githubusercontent.com/mu-semtech/mu-cli/master/README.md',
'homebrew-scripts': 'https://raw.githubusercontent.com/mu-semtech/homebrew-scripts/master/README.md',
'openapi-generator': 'https://raw.githubusercontent.com/mu-semtech/cl-resources-openapi-generator/master/README.md',
};

docTree = [
{
"name": "Documentation",
Expand All @@ -10,53 +51,53 @@ export default class DocsController extends Controller {
"name": "Core",
"link": false,
"value": [
{"name": "Project template", "value":"https://raw.githubusercontent.com/mu-semtech/mu-project/master/README.md", "link": true},
{"name": "Identifier", "value":"https://raw.githubusercontent.com/mu-semtech/mu-identifier/master/README.md", "link": true},
{"name": "Dispatcher", "value":"https://raw.githubusercontent.com/mu-semtech/mu-dispatcher/master/README.md", "link": true},
{"name": "Authorization (new)", "value":"https://raw.githubusercontent.com/mu-semtech/sparql-parser/master/README.md", "link": true},
{"name": "Authorization (old)", "value":"https://raw.githubusercontent.com/mu-semtech/mu-authorization/master/README.md", "link": true},
{"name": "Delta notifier", "value":"https://raw.githubusercontent.com/mu-semtech/delta-notifier/master/README.md", "link": true}
{"name": "Project template", "id": "project-template", "link": true},
{"name": "Identifier", "id": "identifier", "link": true},
{"name": "Dispatcher", "id": "dispatcher", "link": true},
{"name": "Authorization (new)", "id": "authorization-new", "link": true},
{"name": "Authorization (old)", "id": "authorization-old", "link": true},
{"name": "Delta notifier", "id": "delta-notifier", "link": true}
]
},
{
"name": "Templates",
"link": false,
"value": [
{"name": "Javascript template", "value":"https://raw.githubusercontent.com/mu-semtech/mu-javascript-template/master/README.md", "link": true},
{"name": "Ruby template", "value":"https://raw.githubusercontent.com/mu-semtech/mu-ruby-template/master/README.md", "link": true},
{"name": "Python template", "value":"https://raw.githubusercontent.com/mu-semtech/mu-python-template/master/README.md", "link": true},
{"name": "Javascript template", "id": "javascript-template", "link": true},
{"name": "Ruby template", "id": "ruby-template", "link": true},
{"name": "Python template", "id": "python-template", "link": true},
]
},
{
"name": "Microservices",
"link": false,
"value": [
{"name": "Login service", "value":"https://raw.githubusercontent.com/mu-semtech/login-service/master/README.md", "link": true},
{"name": "Registration service", "value":"https://raw.githubusercontent.com/mu-semtech/registration-service/master/README.md", "link": true},
{"name": "Resources service", "value":"https://raw.githubusercontent.com/mu-semtech/mu-cl-resources/master/README.md", "link": true},
{"name": "File service", "value":"https://raw.githubusercontent.com/mu-semtech/file-service/master/README.md", "link": true},
{"name": "Migrations service", "value":"https://raw.githubusercontent.com/mu-semtech/mu-migrations-service/master/README.md", "link": true},
{"name": "Search", "value":"https://raw.githubusercontent.com/mu-semtech/mu-search/master/README.md", "link": true},
{"name": "Cache", "value":"https://raw.githubusercontent.com/mu-semtech/mu-cache/master/README.md", "link": true},
{"name": "Login service", "id": "login-service", "link": true},
{"name": "Registration service", "id": "registration-service", "link": true},
{"name": "Resources service", "id": "resources-service", "link": true},
{"name": "File service", "id": "file-service", "link": true},
{"name": "Migrations service", "id": "migrations-service", "link": true},
{"name": "Search", "id": "search", "link": true},
{"name": "Cache", "id": "cache", "link": true},
]
},
{
"name": "Ember addons",
"link": false,
"value": [
{"name": "Data table", "value":"https://raw.githubusercontent.com/mu-semtech/ember-data-table/master/README.md", "link": true},
{"name": "Login addon", "value":"https://raw.githubusercontent.com/mu-semtech/ember-mu-login/master/README.md", "link": true},
{"name": "Registration addon", "value":"https://raw.githubusercontent.com/mu-semtech/ember-mu-registration/master/README.md", "link": true},
{"name": "Transform helpers", "value":"https://raw.githubusercontent.com/mu-semtech/ember-mu-transform-helpers/master/README.md", "link": true},
{"name": "Data table", "id": "data-table", "link": true},
{"name": "Login addon", "id": "login-addon", "link": true},
{"name": "Registration addon", "id": "registration-addon", "link": true},
{"name": "Transform helpers", "id": "transform-helpers", "link": true},
]
},
{
"name": "Tools",
"link": false,
"value": [
{"name": "mu-cli", "value":"https://raw.githubusercontent.com/mu-semtech/mu-cli/master/README.md", "link": true},
{"name": "Homebrew scripts", "value":"https://raw.githubusercontent.com/mu-semtech/homebrew-scripts/master/README.md", "link": true},
{"name": "OpenAPI generator", "value":"https://raw.githubusercontent.com/mu-semtech/cl-resources-openapi-generator/master/README.md", "link": true},
{"name": "mu-cli", "id": "mu-cli", "link": true},
{"name": "Homebrew scripts", "id": "homebrew-scripts", "link": true},
{"name": "OpenAPI generator", "id": "openapi-generator", "link": true},
]
}
]}
Expand Down
2 changes: 1 addition & 1 deletion app/templates/docs.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
<Documentation @docTree={{this.docTree}}/>
<Documentation @docTree={{this.docTree}} @currentDocUrl={{this.currentDocUrl}} @onDocChange={{this.changeDoc}}/>