implement in-app-wiki #862

newhinton · 2022-05-26T08:45:54Z

Signed-off-by: Felix Nüsse [email protected]
closes #287 and closes #793

Todo:

Welcomescreen	Help	Help

Discussion:

What shortcuts to add
What markdown codes to add
What tipps to add

newhinton · 2022-05-27T13:45:00Z

@korelstar I would like to not reference the appstore badges (and app-icons maybe) via url. I would like to embedd them as assets. However, i could not find out how nextcloud stores static assets, do you know that? One clunky way would be to embedd them base64 encoded in a helper class, but that seems unclean

Edit: found out!

newhinton · 2022-05-27T15:39:41Z

@stefan-niedermann How would you like to be attributed for your app? Is this okay?

newhinton · 2022-05-27T18:02:13Z

I think we could easily put this with all the other outstanding features into a Version 5.0.0. It's a nice round number, and there was quite a bit of work done to justify it 👍

korelstar · 2022-05-29T16:04:16Z

Hey @newhinton : Thanks for your work on this! The screenshots are looking very well so far. Since you are still actively working on this PR, I wait with a final review. But it's going in a good direction!

But I have one request: could you please set this (and other not yet finished) PRs to "draft"? It would be very helpful to have a direct insight if a PR is ready for review or not.

Regarding the version name: I'm using the milestone planing. The plan was to release version 4.4.0 several weeks ago. It should have contained all the stuff that change the public API (attachments, custom file extension) -- but the last thing is still left, since I've not found the time :-( . After that, the plan was to release 4.5.0 with all the UI stuff (three-column layout, help-screen, toolbar etc.). Version 5.0.0 was planned with the switch to the Nextcloud Text editor, but that is currently halted due to the open issues regarding the Text app.

newhinton · 2022-05-29T16:38:36Z

Yes i will convert everything to drafts soon.

However, this is not so drafty-anymore, it is mostly done and we need to discuss content.

Regarding 5.0.0: Since we more or less implement everything text does (except concurrent editing), do we need that issue at all? It does not seem that the issues will be fixed anytime soon, if at all, and since we have a very well working setup with the new additions, i think we can do without it until something major changes.

korelstar · 2022-08-14T09:34:34Z

@newhinton Is there anything to be done here? Could you please rebase the branch when this is ready to review?

newhinton · 2022-08-14T09:37:52Z

Yes and no :D

I think the technical side is done. There was the question wether or not to replace the initial welcome-page with a popup, but this can be done later.

However, we should check two things:
First, if all app-maintainer are okay with beeing mentioned on that page
And second, if we have all keyboard-shortcuts and tips in the help that we want.

But besides that, i think its good to go. (When i will rebase this, i'll also check if there are still console errors)

korelstar · 2022-08-14T19:43:08Z

First, if all app-maintainer are okay with beeing mentioned on that page

Any veto @stefan-niedermann @phedlund ?

And second, if we have all keyboard-shortcuts and tips in the help that we want.

I'll do a deeper review.

package-lock.json

src/App.vue

src/components/AppHelp.vue

korelstar · 2022-08-14T19:33:18Z

src/components/AppHelp.vue

+				{ shortcut: t('notes', 'CTRL+Alt+L'), action: t('notes', 'kes the current line a list element with a number') },
+				{ shortcut: t('notes', 'SHIFT+CTRL+H'), action: t('notes', 'toggleHeadingBigger') },
+				{ shortcut: t('notes', 'F9'), action: t('notes', 'toggleSideBySide') },
+				{ shortcut: t('notes', 'F11'), action: t('notes', 'Make the note fullscreen') },


Hmm. This is not the same like the fullscreen action in the three-dots menu. Hence, remove this entry?

But it is? In the end the tree dot menu calls "requestFullscreen()" on the dom, which acts the exact same way as F11.

At least not in my Firefox: pressing F11 goes into fullscreen but all the Nextcloud frame and app navigation is still visible. Using the fullscreen option shows the note only without any distracting frame.

src/components/AppHelp.vue

korelstar · 2022-08-14T19:38:56Z

src/components/Welcome.vue

+			createNote('')
+				.then(note => {
+					const query = { new: getDefaultSampleNote() }
+					this.$router.push({
+						name: 'note',
+						params: { noteId: note.id.toString() },
+						query,
+					})
+				})
+				.catch(() => {
+				})


I don't like this approach, because it generates a very long URI. Instead, you should add a second parameter to createNote that takes the content and directly sends it to the server in the same request that creates the new note.

Besides the query, this is how the sidebar is doing it. (If i remember correctly, that's where i found the code in the first place. I just extracted the query so that i could add content more cleanly.

Should we change that in this PR?

Sidebar? What do you mean?

But yes, please do not put a whole note in a query parameter. :-)

korelstar · 2022-08-14T19:40:08Z

src/components/Note.vue

+
+					const newContent = this.$route.query.new
+					if (this.isNewNote && (newContent !== '' && newContent != null)) {
+						this.note.content = newContent
+						this.onManualSave()
+					}


I don't like this approach, because it generates a very long URI. Instead, you should add a second parameter to createNote that takes the content and directly sends it to the server in the same request that creates the new note.

stefan-niedermann · 2022-08-14T20:42:10Z

How would you like to be attributed for your app? Is this okay?

That's fine, thanks 👍

Any veto @stefan-niedermann?

Nope 🙂

newhinton · 2022-10-03T10:11:33Z

@korelstar I have implemented a lot of the changes you mentioned.

However, do we have any tips we want to add? Otherwise i need to remove that section from the help.

newhinton · 2022-10-03T10:17:39Z

~~Oh damn. I broke something badly, i somewhere have the three column layout merged in there.~~

Fixed it.

korelstar

@korelstar I have implemented a lot of the changes you mentioned.
However, do we have any tips we want to add? Otherwise i need to remove that section from the help.

Thanks so far! I think it can be removed, for now. Would you mind doing a rebase (due to #928)?

korelstar · 2022-10-03T15:17:32Z

src/components/Welcome.vue

+			<button class="button-icon-add icon-add" @click="onNewNote">
+				{{ t('notes', 'Create a sample note with markdown') }}
+			</button>


Please use NcButton from @nextcloud/vue instead

korelstar · 2022-10-03T15:18:00Z

src/components/AppHelp.vue

+				<button class="button-icon-add icon-add" @click="onNewNote">
+					{{ t('notes', 'Create a sample note with markdown') }}
+				</button>


Please use NcButton from @nextcloud/vue instead

newhinton · 2022-10-04T10:53:01Z

@korelstar So i did rebase, but it did not want to push. For now i have not force pushed my code, but created a second branch.

You can check it here: https://github.com/nextcloud/notes/tree/feature/noid/help2

If it works for you, i can force push later.

~~There is one bug i encountered: Closing or Opening the sidebar toggles the help. I will have to check that~~

Signed-off-by: Felix Nüsse <[email protected]>

Update Text Signed-off-by: Felix Nüsse <[email protected]>

Signed-off-by: Felix Nüsse <[email protected]>

fix padding for help Signed-off-by: Felix Nüsse <[email protected]>

Signed-off-by: Felix Nüsse <[email protected]>

korelstar · 2022-10-16T13:49:35Z

Hey @newhinton ! I did a rebase of feature/noid/help2 to current master and fixed all the issues that I've criticized. I've pushed the new stuff to feature/noid/help (this PR). Please have a look from your side on this. I will do a last review after that.

Signed-off-by: korelstar <[email protected]>

newhinton · 2022-10-17T13:06:09Z

@korelstar It looks good to me! Thanks for helping out

newhinton requested review from korelstar and stefan-niedermann May 26, 2022 08:49

korelstar added this to the 4.5.0 milestone May 29, 2022

newhinton changed the title ~~implement in-app-wiki~~ Draft: implement in-app-wiki May 29, 2022

newhinton marked this pull request as draft May 29, 2022 20:26

newhinton changed the title ~~Draft: implement in-app-wiki~~ implement in-app-wiki May 29, 2022

newhinton marked this pull request as ready for review August 6, 2022 13:14

korelstar modified the milestones: 4.5.0, 4.6.0 Aug 13, 2022

korelstar requested changes Aug 14, 2022

View reviewed changes

korelstar modified the milestones: 4.6.0, 4.7.0 Oct 1, 2022

newhinton force-pushed the feature/noid/help branch from cecf6c8 to 6c726c4 Compare October 3, 2022 10:25

korelstar requested changes Oct 3, 2022

View reviewed changes

newhinton mentioned this pull request Oct 4, 2022

Three column layout #842

Closed

newhinton added 3 commits October 16, 2022 12:24

implement in-app-wiki

51365eb

Signed-off-by: Felix Nüsse <[email protected]>

use apple store link

98466fe

Signed-off-by: Felix Nüsse <[email protected]>

add tips and tricks section

55a949c

Signed-off-by: Felix Nüsse <[email protected]>

newhinton and others added 18 commits October 16, 2022 12:24

add more translations

73ba3c7

Signed-off-by: Felix Nüsse <[email protected]>

fix feature-styling for lines with icons

985a8f7

Signed-off-by: Felix Nüsse <[email protected]>

define props only once

914f376

Signed-off-by: Felix Nüsse <[email protected]>

update welcome and help appsections

948f695

Signed-off-by: Felix Nüsse <[email protected]>

increase padding for welcome

c22192f

Signed-off-by: Felix Nüsse <[email protected]>

apply suggestions by @korelstar

7480f91

Signed-off-by: Felix Nüsse <[email protected]>

remove duplicate new-note-button

41c1125

Update Text Signed-off-by: Felix Nüsse <[email protected]>

fix rebase issues

57b7fe3

Signed-off-by: Felix Nüsse <[email protected]>

remove close button

632ac91

fix padding for help Signed-off-by: Felix Nüsse <[email protected]>

use nc button

fac451e

Signed-off-by: Felix Nüsse <[email protected]>

fix help not closing properly

db98f92

Signed-off-by: Felix Nüsse <[email protected]>

remove custom stylesheet

8cbcfcc

use material-design icon

64f24dd

improve translatability and use no copyright-relevant quote

13f3b34

use title

2c1979d

fix illegal modification of prop

29ba971

fix lint

3ba1f6f

fix long URI GET parameter

e62eecf

korelstar force-pushed the feature/noid/help branch from e9e47d2 to e62eecf Compare October 16, 2022 13:40

korelstar added 2 commits October 16, 2022 15:55

rename sample note

a747277

fix Event state

8696ffa

Signed-off-by: korelstar <[email protected]>

korelstar added 4 commits October 17, 2022 21:16

remove duplicate code

aedc3e2

fix URL

9dec2bf

fix language

f0b0757

move constant data to data

d6b6128

korelstar approved these changes Oct 18, 2022

View reviewed changes

korelstar merged commit c9d8af5 into master Oct 18, 2022

korelstar deleted the feature/noid/help branch October 18, 2022 06:53

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

implement in-app-wiki #862

implement in-app-wiki #862

newhinton commented May 26, 2022 •

edited by korelstar

Loading

newhinton commented May 27, 2022 •

edited

Loading

newhinton commented May 27, 2022

newhinton commented May 27, 2022

korelstar commented May 29, 2022

newhinton commented May 29, 2022

korelstar commented Aug 14, 2022

newhinton commented Aug 14, 2022

korelstar commented Aug 14, 2022

korelstar Aug 14, 2022

newhinton Oct 3, 2022

korelstar Oct 3, 2022

korelstar Aug 14, 2022

newhinton Oct 3, 2022

korelstar Oct 3, 2022

korelstar Aug 14, 2022

stefan-niedermann commented Aug 14, 2022

newhinton commented Oct 3, 2022

newhinton commented Oct 3, 2022 •

edited

Loading

korelstar left a comment

korelstar Oct 3, 2022

korelstar Oct 3, 2022

newhinton commented Oct 4, 2022 •

edited

Loading

korelstar commented Oct 16, 2022

newhinton commented Oct 17, 2022

implement in-app-wiki #862

implement in-app-wiki #862

Conversation

newhinton commented May 26, 2022 • edited by korelstar Loading

newhinton commented May 27, 2022 • edited Loading

newhinton commented May 27, 2022

newhinton commented May 27, 2022

korelstar commented May 29, 2022

newhinton commented May 29, 2022

korelstar commented Aug 14, 2022

newhinton commented Aug 14, 2022

korelstar commented Aug 14, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stefan-niedermann commented Aug 14, 2022

newhinton commented Oct 3, 2022

newhinton commented Oct 3, 2022 • edited Loading

korelstar left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

newhinton commented Oct 4, 2022 • edited Loading

korelstar commented Oct 16, 2022

newhinton commented Oct 17, 2022

newhinton commented May 26, 2022 •

edited by korelstar

Loading

newhinton commented May 27, 2022 •

edited

Loading

newhinton commented Oct 3, 2022 •

edited

Loading

newhinton commented Oct 4, 2022 •

edited

Loading