Skip to content
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.

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

SPA mode #327

Merged
merged 13 commits into from
Jun 11, 2019
Merged

SPA mode #327

merged 13 commits into from
Jun 11, 2019

Conversation

xbill82
Copy link
Contributor

@xbill82 xbill82 commented Jun 11, 2019

What does this PR do?

Replaces all the <a> tags in the Sidebar component (and others) with <router-link> so that the entire website behaves like an SPA after first load.

Thanks to @alexandrebouthinon for helping on this! 🎉

How should this be manually tested?

Build the docs locally and navigate with the Network tab of your Devtools open. You'll see that only a tiny js script is loaded after clicking on a link.

Other changes

The same substitution is operated on the following components

  • Redirect.vue
  • SDKIndex.vue
  • Tabs.vue
  • TabsMobile.vue

@xbill82 xbill82 self-assigned this Jun 11, 2019
@xbill82 xbill82 changed the title Fixed link generation in Sidebar Fixed SPA mode Jun 11, 2019
@scottinet
Copy link
Contributor

What's the scope of this PR?
Should this change be applied to documentation pages themselves (e.g. https://raw.githubusercontent.com/kuzzleio/documentation/3-dev/src/core/1/api/essentials/query-syntax/index.md)?

@scottinet scottinet changed the title Fixed SPA mode Fix SPA mode Jun 11, 2019
@alexandrebouthinon
Copy link
Member

@scottinet : This PR modify Vue.js components behavior so it apply on eventually all the documentation pages.

Copy link
Member

@alexandrebouthinon alexandrebouthinon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's fast now! Good job! 👍
BTF

@xbill82 xbill82 changed the title Fix SPA mode SPA mode Jun 11, 2019
Copy link
Contributor

@benoitvidis benoitvidis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does not build on my system:

Rendering page: /core/1/api/controllers/admin/dump/[Vue warn]: Error in render: "TypeError: _vm.generateLink is not a function"

found in

---> <TabsMobile>
       <Sidebar>
         <Layout>
           <Anonymous>
             <Root>
error Error rendering /core/1/api/controllers/admin/dump/: false
undefined
TypeError: _vm.generateLink is not a function
    at Proxy.render (src/.vuepress/theme/TabsMobile.vue?c323:1:423)
    at VueComponent.Vue._render (/home/bvidis/dev/kuzzle/documentation/node_modules/vue/dist/vue.runtime.common.dev.js:3532:22)
    at resolve (/home/bvidis/dev/kuzzle/documentation/node_modules/vue-server-renderer/build.dev.js:8400:27)

Looks the import of the getValidLinkByRootPath is missing from the TabsMobile.vue component.

@xbill82
Copy link
Contributor Author

xbill82 commented Jun 11, 2019

Thanks @benoitvidis it's fixed

@Aschen Aschen merged commit 970b464 into 3-dev Jun 11, 2019
@Aschen Aschen deleted the sidebar-links-fix branch June 11, 2019 16:02
This was referenced Jun 12, 2019
xbill82 added a commit that referenced this pull request Jun 13, 2019
# [3.0.0](https://github.com/kuzzleio/documentation/releases/tag/3.0.0) (2019-06-12)


#### Bug fixes

- [ [#298](#298) ] Fix bulk import return   ([Aschen](https://github.com/Aschen))
- [ [#325](#325) ] Adapt legacy redirection   ([Aschen](https://github.com/Aschen))
- [ [#322](#322) ] Fix remaining dead links and add check_link to CI   ([Aschen](https://github.com/Aschen))
- [ [#304](#304) ] Fix sdk js tests   ([benoitvidis](https://github.com/benoitvidis))

#### New features

- [ [#299](#299) ] Documentation for wildcard events   ([thomasarbona](https://github.com/thomasarbona))
- [ [#321](#321) ] Add guide about secrets management with the Vault   ([Aschen](https://github.com/Aschen))
- [ [#300](#300) ] Add page about bulk:write and bulk:mwrite   ([Aschen](https://github.com/Aschen))

#### Enhancements

- [ [#327](#327) ] SPA mode   ([xbill82](https://github.com/xbill82))
- [ [#324](#324) ] Update Redis version   ([Aschen](https://github.com/Aschen))
- [ [#316](#316) ] Sdks authenticated connected props   ([Aschen](https://github.com/Aschen))
- [ [#317](#317) ] Add new way for updateSpecifications & validateSpecifications   ([thomasarbona](https://github.com/thomasarbona))
- [ [#296](#296) ] Rewrite the Realtime guide   ([Aschen](https://github.com/Aschen))
- [ [#301](#301) ] Deprecate realtime join   ([Aschen](https://github.com/Aschen))
- [ [#291](#291) ] Getting started React + improve snippetManager   ([thomasarbona](https://github.com/thomasarbona))
- [ [#294](#294) ] Add s3 plugin   ([Aschen](https://github.com/Aschen))
- [ [#292](#292) ] Add since   ([Aschen](https://github.com/Aschen))
- [ [#276](#276) ] [KZL-907] Getting started dev plugin   ([Yoann-Abbes](https://github.com/Yoann-Abbes))
- [ [#284](#284) ] Extending the JS SDK with controllers   ([Aschen](https://github.com/Aschen))
- [ [#271](#271) ] Add documentation page about mappings   ([Aschen](https://github.com/Aschen))

#### Others

- [ [#314](#314) ] Add a clustering guide   ([scottinet](https://github.com/scottinet))
- [ [#319](#319) ] Getting-started-sdk-JS6-architecture   ([berthieresteban](https://github.com/berthieresteban))
- [ [#311](#311) ] Add PDF sending example for Request.setResult   ([Aschen](https://github.com/Aschen))
- [ [#315](#315) ] Normalize directories and generate redirections   ([Aschen](https://github.com/Aschen))
- [ [#309](#309) ] Port #284 to 3-dev   ([berthieresteban](https://github.com/berthieresteban))
- [ [#308](#308) ] Port #283 to 3-dev   ([berthieresteban](https://github.com/berthieresteban))
- [ [#307](#307) ] Port #282 to 3-dev   ([berthieresteban](https://github.com/berthieresteban))
- [ [#306](#306) ] Port #280 to 3-dev   ([berthieresteban](https://github.com/berthieresteban))
- [ [#312](#312) ] Port 278 to 3-dev   ([Aschen](https://github.com/Aschen))
- [ [#310](#310) ] Port #277 to 3-dev   ([Aschen](https://github.com/Aschen))
- [ [#305](#305) ] Port #275 to 3-dev   ([Aschen](https://github.com/Aschen))
- [ [#303](#303) ] Port #274 to 3-dev   ([Aschen](https://github.com/Aschen))
- [ [#302](#302) ] Port #271 to 3-dev   ([Aschen](https://github.com/Aschen))
- [ [#313](#313) ] Port #266 to 3-dev   ([Yoann-Abbes](https://github.com/Yoann-Abbes))
- [ [#290](#290) ] [KZL-1050] Role template example in the documentation   ([Yoann-Abbes](https://github.com/Yoann-Abbes))
- [ [#293](#293) ] [KZL-1036] Add available plugins   ([Yoann-Abbes](https://github.com/Yoann-Abbes))
- [ [#286](#286) ] Embedded protocols   ([benoitvidis](https://github.com/benoitvidis))
---
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants