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.

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

Jump to bottom

Dashboard API #21346

Merged
merged 17 commits into from
Jul 15, 2020
Merged

Dashboard API #21346

merged 17 commits into from
Jul 15, 2020

Conversation

juliushaertl
Copy link
Member

@juliushaertl juliushaertl commented Jun 9, 2020 •
edited
Loading

This PR is the first part of the planned dashboard work. For now it contains the following parts:

  • Deprecating the old dashboard API
  • Add a simplified new API as proposed in Dashboard overview #20930
  • Add a new dashboard app that mainly takes care of providing dom elements so that apps can render their own views into it.

A reference panel implementation can be found in nextcloud/recommendations#229

Required steps for implementing a panel as an app developer: 📖 nextcloud/documentation#2168

ToDo

Follow-up

  • Implement dynamic sorting and adding/removing panels (follow up PR)
  • App store category for apps supporting dashboard (follow up PR)
  • Check if we can make the default app dynamic depending on a user setting (follow up PR)
  • Decide if this should be the default app and how the order of apps should be in the app menu (follow up PR)
  • Updating Nextcloud with the new Dashboard app and the old one installed will need Use shipped.json file from new release updater#255 to make sure the app is properly replaced
    • With a spearate app directory, using the same app id as the current dashboard app should not be an issue if we have a higher app version available

@rullzer rullzer added the 2. developing Work in progress label Jun 10, 2020
@jancborchardt
Copy link
Member

Great work, added some design & layout fixes. Now just needs the panels (or mocks) for Calendar, Mail and Talk. :)

@juliushaertl juliushaertl force-pushed the enh/20930/dashboard branch 2 times, most recently from 30a3f3a to 4ab2dc5 Compare June 23, 2020 15:05
@juliushaertl juliushaertl added 3. to review Waiting for reviews and removed 2. developing Work in progress labels Jun 23, 2020
@juliushaertl juliushaertl marked this pull request as ready for review June 23, 2020 15:28
@juliushaertl
Copy link
Member Author

Acceptance tests would still need some more work due to the new default app, but this should be good for a first review round until those are figured out. 😉

ChristophWurst
ChristophWurst reviewed Jun 23, 2020
View reviewed changes
apps/dashboard/appinfo/info.xml Show resolved Hide resolved
apps/dashboard/lib/Controller/DashboardController.php Outdated Show resolved Hide resolved
apps/dashboard/lib/Controller/DashboardController.php Show resolved Hide resolved
apps/dashboard/src/App.vue Outdated Show resolved Hide resolved
lib/public/Dashboard/IManager.php Outdated Show resolved Hide resolved
lib/public/Dashboard/IPanel.php Show resolved Hide resolved
lib/public/Dashboard/IRegisterPanelEvent.php Outdated Show resolved Hide resolved
@rullzer
Copy link
Member

rullzer commented Jun 24, 2020

Acceptance tests would still need some more work due to the new default app, but this should be good for a first review round until those are figured out. wink

Maybe as discussed we don't add it as default just yet. only when we think it is ready?

@juliushaertl
Copy link
Member Author

Maybe as discussed we don't add it as default just yet. only when we think it is ready?

Yes, I've dropped that for now and added it to the todo list for the next steps.

@juliushaertl
Copy link
Member Author

/compile amend /

This was referenced Jun 24, 2020
Merged
Merged
@juliushaertl juliushaertl mentioned this pull request Jun 26, 2020
Merged
9 tasks
juliushaertl and others added 16 commits July 15, 2020 09:24
@juliushaertl
Add new dashboard public API
673d70d 
Signed-off-by: Julius Härtl <jus@bitgrid.net>
@juliushaertl
Deprecate old dashboard API
544fcdb 
Signed-off-by: Julius Härtl <jus@bitgrid.net>
@juliushaertl
Add dashboard app
5a18749 
Signed-off-by: Julius Härtl <jus@bitgrid.net>
@jancborchardt @juliushaertl
Modify dashboard welcome sentences
4b9d47f 
Signed-off-by: Jan-Christoph Borchardt <hey@jancborchardt.net>
@jancborchardt @juliushaertl
Fix Dashboard layout, positioning and responsiveness
829bf1a 
Signed-off-by: Jan-Christoph Borchardt <hey@jancborchardt.net>
@juliushaertl
Separate icon from translatable text
a0cd760 
Signed-off-by: Julius Härtl <jus@bitgrid.net>
@juliushaertl
Update autoloader
86a7d16 
Signed-off-by: Julius Härtl <jus@bitgrid.net>
@juliushaertl
Move to lazy panel registration during registration context
81e5593 
Signed-off-by: Julius Härtl <jus@bitgrid.net>
@juliushaertl
Deprecate panel register event right away but keep it for not breakin…
f7c04b0 
…g backward compatible apps

Signed-off-by: Julius Härtl <jus@bitgrid.net>
@juliushaertl
Initialize panels early to make sure that scripts can be loaded
66ce9ed 
Signed-off-by: Julius Härtl <jus@bitgrid.net>
@juliushaertl
Cleanup public api methods
b71de68 
Signed-off-by: Julius Härtl <jus@bitgrid.net>
@jancborchardt @juliushaertl
Update Dashboard app icon
879b756 
Signed-off-by: Jan-Christoph Borchardt <hey@jancborchardt.net>
@juliushaertl
Add load method for apps to bootstrap their panels
31a1494 
Signed-off-by: Julius Härtl <jus@bitgrid.net>
@juliushaertl
Load more than one panel
e6fb1b9 
Signed-off-by: Julius Härtl <jus@bitgrid.net>
@juliushaertl
Dashboard strict typing
35bdb99 
Signed-off-by: Julius Härtl <jus@bitgrid.net>
@juliushaertl
Include name in translatable greeting
0c35218 
Signed-off-by: Julius Härtl <jus@bitgrid.net>
@juliushaertl juliushaertl force-pushed the enh/20930/dashboard branch 2 times, most recently from 053f7cf to 1026be8 Compare July 15, 2020 07:33
@juliushaertl
Copy link
Member Author

/compile amend /

@juliushaertl
Bump bundles
6b2bb32 
Signed-off-by: Julius Härtl <jus@bitgrid.net>
@juliushaertl
Copy link
Member Author

Ah it was the missing map file.

@rullzer rullzer merged commit f04f932 into master Jul 15, 2020
@rullzer rullzer deleted the enh/20930/dashboard branch July 15, 2020 09:10
@MorrisJobke
Copy link
Member

Breaks master tests - let me fix them.

MorrisJobke added a commit that referenced this pull request Jul 15, 2020
@MorrisJobke
Fix integration test due to new dashboard app
8dd48f3 
See #21346

Signed-off-by: Morris Jobke <hey@morrisjobke.de>
@MorrisJobke MorrisJobke mentioned this pull request Jul 15, 2020
Merged
@MorrisJobke
Copy link
Member

Breaks master tests - let me fix them.

#21849

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ChristophWurst ChristophWurst ChristophWurst approved these changes

@nickvergessen nickvergessen nickvergessen approved these changes

@rullzer rullzer Awaiting requested review from rullzer

@jancborchardt jancborchardt Awaiting requested review from jancborchardt

@MorrisJobke MorrisJobke Awaiting requested review from MorrisJobke

@skjnldsv skjnldsv Awaiting requested review from skjnldsv

Assignees
No one assigned
Labels
3. to review Waiting for reviews enhancement feature: dashboard
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
8 participants
@juliushaertl @jancborchardt @rullzer @MorrisJobke @nickvergessen @ChristophWurst @skjnldsv @MarkPartlett