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

Documentation bump #684

Merged
merged 7 commits into from
Apr 4, 2018
Merged

Documentation bump #684

merged 7 commits into from
Apr 4, 2018

Conversation

skjnldsv
Copy link
Member

@skjnldsv skjnldsv commented Feb 16, 2018

WIP

  • New button
  • Inputs/form in popover
  • Top right header

@@ -5,6 +5,7 @@ Design guidelines
.. toctree::
:maxdepth: 2

newbutton
Copy link
Member

Choose a reason for hiding this comment

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

I'd say this should be part of the navigation section. 😉

Copy link
Member Author

Choose a reason for hiding this comment

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

I asked myself the same question! I think you're right :)

Copy link
Member Author

Choose a reason for hiding this comment

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

In the other hand, the new button is placed outside of the <div id="app-navigation">, so I'm not really sure. :/

Copy link
Member

Choose a reason for hiding this comment

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

Why is it placed outside? Then it wouldn't be in the sidebar anymore.

Copy link
Member Author

Choose a reason for hiding this comment

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

Hu! I'm an idiot, I wanted to say outside the ul navigation, but yes, this is inside the app-navigation. ^^'

Copy link
Member Author

Choose a reason for hiding this comment

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

Nevertheless, we also have a specific settings page which is also in the app-navigation div, so which do you prefer? Inside the navigation page or like this ?

Copy link
Member

Choose a reason for hiding this comment

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

Ah ok 😉 Makes sense to have them grouped by the "app-navigation". Maybe we should also move the settings stuff to there, since that is in the app-navigation as well.

Copy link
Member Author

Choose a reason for hiding this comment

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

I agree! :)

+ Wording fixes and introduction to the full navigation element

Signed-off-by: John Molakvoæ (skjnldsv) <skjnldsv@protonmail.com>
@skjnldsv skjnldsv force-pushed the documentation-bump-14 branch from d686403 to b672fb4 Compare February 17, 2018 17:50
-------------

A 'new' button is just a stylised button located above the navigation part of your app.
It can be tied to whatever you want as long as it follow those simple rules.
Copy link
Member Author

@skjnldsv skjnldsv Feb 17, 2018

Choose a reason for hiding this comment

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

It can be tied to whatever action you want as long as it follow those simple rules.

?

Copy link
Member

Choose a reason for hiding this comment

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

Maybe just call it primary action button, since it is then not limited to a create action. And we can get rid of the It can be tied to whatever you want sentence.

* a menu
* a settings area

The 'new' button and the settings area are optional.
Copy link
Member Author

Choose a reason for hiding this comment

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

Should we add a global code block to show a full example?

Copy link
Member

Choose a reason for hiding this comment

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

Should be clear from the other examples imo.

Signed-off-by: John Molakvoæ (skjnldsv) <skjnldsv@protonmail.com>
@skjnldsv skjnldsv force-pushed the documentation-bump-14 branch from e5d3a15 to 7633648 Compare February 17, 2018 17:56
@skjnldsv
Copy link
Member Author

@juliushaertl Here we go! :)
Can you help and review nextcloud/server#8373 pls?
So I can document this and add it here?

Also, see comments I made on this pr :)

cc @jancborchardt

@skjnldsv skjnldsv mentioned this pull request Feb 27, 2018
18 tasks
Signed-off-by: John Molakvoæ (skjnldsv) <skjnldsv@protonmail.com>
Signed-off-by: John Molakvoæ (skjnldsv) <skjnldsv@protonmail.com>
------

* Stay simple, don't use overcomplicated text in this button.
* Avoid using sentences longer than one line.
Copy link
Member

Choose a reason for hiding this comment

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

Maybe also:

  • Only use a single button


To create a settings area create a div with the id ``app-settings`` inside the ``app-navigation`` div.

* The data attribute ``data-apps-slide-toggle`` slides up a target area using a jQuery selector and hides the area if the user clicks outside of it.
Copy link
Member

Choose a reason for hiding this comment

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

Is the toggling done by server code or do the app developer need to implement it themselves?

Copy link
Member Author

Choose a reason for hiding this comment

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

server :)

Introduction
===============

The navigation section of any nextcloud app is the left sidebar.
Copy link
Member

Choose a reason for hiding this comment

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

nextcloud -> Nextcloud

Signed-off-by: John Molakvoæ (skjnldsv) <skjnldsv@protonmail.com>
@skjnldsv skjnldsv force-pushed the documentation-bump-14 branch from 051ce12 to e31fdc2 Compare March 6, 2018 09:49
Signed-off-by: John Molakvoæ (skjnldsv) <skjnldsv@protonmail.com>
@skjnldsv skjnldsv force-pushed the documentation-bump-14 branch from e31fdc2 to 3db48fc Compare March 6, 2018 09:50
Signed-off-by: John Molakvoæ (skjnldsv) <skjnldsv@protonmail.com>
@skjnldsv
Copy link
Member Author

Let's get this in! :)
@nextcloud/documentation

@MorrisJobke
Copy link
Member

Let's get this in! :)

Let's wait until 13 is branched off.

@MorrisJobke MorrisJobke added this to the Nextcloud 14 milestone Mar 12, 2018
@skjnldsv
Copy link
Member Author

@MorrisJobke clear? :)

@MorrisJobke
Copy link
Member

@MorrisJobke clear? :)

Pushed stable13 - ready to go 👍

@MorrisJobke MorrisJobke merged commit 1d776eb into master Apr 4, 2018
@MorrisJobke MorrisJobke deleted the documentation-bump-14 branch April 4, 2018 10:14
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.

4 participants