search

ElektraInitiative / libelektra

Elektra serves as a universal and secure framework to access configuration settings in a global, hierarchical key database.
https://www.libelektra.org
BSD 3-Clause "New" or "Revised" License
208 stars 123 forks source link

website issues #1151

Closed markus2330 closed 7 years ago

markus2330 commented 7 years ago

Frontend

Questions

Archive

Frontend

Backend

Other

Questions

markus2330 commented 7 years ago

I changed the text a bit. Can you modify the icon for "batteries included"?

Namoshek commented 7 years ago

Can you modify the icon for "batteries included"?

Which one should I take? (see http://fontawesome.io/icons/ for a list, you can search for battery too) I think battery-three-quarters is good (shows better that is is a bettery) or battery-full in case we want to show that we are awesome. :+1:

The points where I don't write something, I'll change. Btw, can we change #1108 then?

use some other plugin per default in snippet conversion (not dump), maybe line is best

The dropdown is sorted by the plugin status, i.e. best plugin at top. Of course it can be changed, but it seems dirty...

please add icons for the orientation, too

Are you talking about the 3 points on the bottom?

registration page: I enter first both passwords, then user, then mail, suddenly it says that second password is wrong

Tried with three test input-sets, but cannot reproduce. There is also no connection between the validation of the fields actually...

when creating snippets: clicking on "?" does not do anything (for hover you need patience, please show it immediately)

Have to see what I can do. The behavior of the HTML title-attribute is browser dependend, so I have no influence there. Only solution would be to switch to a tooltip plugin, but would be nice to avoid that...

scope and organization should have defaults, description should not be enforced

Suggestions? Personally, I don't think it makes sense and that we should wait and see if it actually makes sense...

when submitting errornous snippet, it says github button below should be pressed, but there is no such button

Good point, but minor. I'd like to fix this with implementing a button that does the same as for the conversion, but other things are more urgent.

green tick in snippet window overlaps with scroll bar

Don't think I can fix that.

when submitting view-source:http://markus-raab.org/Info/Config/Elektra/filesystems.xml xml files gets accepted, but content gets discarded (selecting xmltool as plugin)? Same for line plugin and others? Main functionality seems to be broken?

Something seems broken there, will have a look.

how to list all snippets I have created?

You go to the search, press "advanced options", select "filter by" and enter your name to search for. If you think we should have a button to this list in the profile, put it on the todo list. ^^

space separated tags get automatically merged to a single tag? What is the rationale here?

Tags do not allow spaces (that's the whole purpose of tags - a single word as description).

Do we really need the news.json? Can't it be a part of structure.in?

The structure.json is an array at the highest level, so merging it with news is not going to work. But I don't understand the problem, because the news.json is only generated, but never published on its own... it is put into the JS application.

Is it possible to use all html in src/tools/rest-frontend/public/assets/translations/en.json? Is it necessary/useful to use ui-sref for links?

Yes, you can use all HTML, but the place where the key will be used has to be marked with the translate-compile directive additionally. On the one hand its a safety thingy, on the other hand I never thought we would need it for all keys. ui-sref is only for internal links on the website - and yes, it should be used for those. If you use a normal a-tag for an internal link, it will lead to a refresh and rebootstrap of the page, which is not good. ui-sref operates on the state name by the way, not on links.

markus2330 commented 7 years ago

Hi!

Which one should I take? (see http://fontawesome.io/icons/ for a list, you can search for battery too) I think battery-three-quarters is good (shows better that is is a bettery) or battery-full in case we want to show that we are awesome. :+1:

Yes, awesome (http://fontawesome.io/icon/battery-full/) is ok.

The points where I don't write something, I'll change. Btw, can we change

1108 then?

The leftover there is changing the color theme for asciinema. I renamed the issue.

use some other plugin per default in snippet conversion (not dump), maybe line is best The dropdown is sorted by the plugin status, i.e. best plugin at top. Of course it can be changed, but it seems dirty...

Isn't it possible to preselect something which are not at top?

We could have some "top choices" and the rest is sorted by name, couldn't we?

please add icons for the orientation, too

Are you talking about the 3 points on the bottom?

Yes, the word "orientation" is from the translation file.

registration page: I enter first both passwords, then user, then mail, suddenly it says that second password is wrong Tried with three test input-sets, but cannot reproduce. There is also no connection between the validation of the fields actually...

Strange, I tried it twice with Firefox 45.5.0. So its a AngularJS bug?

when creating snippets: clicking on "?" does not do anything (for hover you need patience, please show it immediately) Have to see what I can do. The behavior of the HTML title-attribute is browser dependend, so I have no influence there. Only solution would be to switch to a tooltip plugin, but would be nice to avoid that...

When clicking would do something the hover behavior wouldn't be important.

scope and organization should have defaults, description should not be enforced Suggestions? Personally, I don't think it makes sense and that we should wait and see if it actually makes sense...

I am afraid it is currently too tiresome to create snippets for the average attention span people have. The feedback of others was really clear here.

when submitting errornous snippet, it says github button below should be pressed, but there is no such button Good point, but minor. I'd like to fix this with implementing a button that does the same as for the conversion, but other things are more urgent.

The list is not ordered by urgency or priority.

1033 are still the high priority issues

how to list all snippets I have created?

You go to the search, press "advanced options", select "filter by" and enter your name to search for. If you think we should have a button to this list in the profile, put it on the todo list. ^^

Yes, we really should have! Its on the todo list.

space separated tags get automatically merged to a single tag? What is the rationale here? Tags do not allow spaces (that's the whole purpose of tags - a single word as description).

So how does the interface work? Do I have to click to add multiple tags?

Do we really need the news.json? Can't it be a part of structure.in?

The structure.json is an array at the highest level, so merging it with news is not going to work. But I don't understand the problem, because the news.json is only generated, but never published on its own... it is put into the JS application.

Then the issue is that the file was added to the repo?

[...] is not good. ui-sref operates on the state name by the way, not on links.

I suppose its AngularJS 101, but can you add it to the docu?

best regards

Namoshek commented 7 years ago

Strange, I tried it twice with Firefox 45.5.0. So its a AngularJS bug?

Can't tell. But as normal people do not work against the flow of forms, its not worth to investigate in my opinion.

When clicking would do something the hover behavior wouldn't be important.

I can't force the title to show earlier, only a move towards a tooltip plugin would help.

So how does the interface work? Do I have to click to add multiple tags?

You write something, press enter, write something, press enter... yes, it is also counter-intuitive for me, as enter often forces the form to submit, but that's how the plugin works unfortunately.

Then the issue is that the file was added to the repo?

Was it? If so, yes, it is.

markus2330 commented 7 years ago

its not worth to investigate in my opinion.

Ok, its low-priority anyway.

I can't force the title to show earlier, only a move towards a tooltip plugin would help.

Ok, lets keep the issue for later then if miscategorization really happens.

Was it? If so, yes, it is.

It still is?

Namoshek commented 7 years ago

please add icons for the orientation, too

Just realized now that I omitted them intentionally. It looks crowded with so many icons and it is also very hard to find fitting ones for these points. A simple arrow (enumeration sign basically) is no problem, but I still think it looks crowded.

markus2330 commented 7 years ago

Yes, it looks a bit crowded but reducing icons seems not to be the best way to deal with it. I still hope we can change the main page to have a multi-page experience with much more whitespace, unfortunately @waht seems to be busy at the moment.

Anyway: the button has the same number of columns as above, so it should work the same way? And I am sure you can find some nice icons ;)

Btw. do you have some ideas how we can bring icons into the the tutorials and NEWS entries to make them look nicer?

Namoshek commented 7 years ago

In the text or where exactly?

markus2330 commented 7 years ago

Yes, next to the text (e.g. on the left side). For example "Get It!" and "Stay tuned!" would look much nicer. Hopefully you will find other opportunities while writing the release notes for the homepage!

Namoshek commented 7 years ago

I doubt we can do that easily...

markus2330 commented 7 years ago

Ok, it is a minor thing, let us keep it in the backlog.

Namoshek commented 7 years ago

when submitting view-source:http://markus-raab.org/Info/Config/Elektra/filesystems.xml xml files gets accepted, but content gets discarded (selecting xmltool as plugin)?

The issue is clearly with the XML plugin. When I use absolute keys in the xml file (the ones that the snippet will have when it gets stored), everything works fine. The import with relative paths does also not work with kdb import dir/test xmltool < filesystems.xml.

I think I read somewhere something about compile-time configuration for the xml plugin with relative keys. Either we use such an option for the website or we omit the plugin entirely... doesn't make sense to work with absolute paths.

Same for line plugin and others?

This is another issue that I'll fix right away.

markus2330 commented 7 years ago

Thanks, I opened #1159 for the XML relative paths issue. Seems like this ticket is nearly finished.

Do you think it is useful now to let more people test the snippet service? I would prefer if the snippet service already runs on the new server for further tests.

Namoshek commented 7 years ago

ui-sref is only for internal links on the website - and yes, it should be used for those. If you use a normal a-tag for an internal link, it will lead to a refresh and rebootstrap of the page, which is not good. ui-sref operates on the state name by the way, not on links.

I was actually wrong about this point, you can also use href for internal links, the router will match them automatically (e.g. href="/plugins/readme" will work too instead of ui-sref="main.dyn.plugins({file:'readme'})"). I guess that is a good info for not-so-angular people.

It actually works that good that the router will give you a 404 page, even if you request something like the feed.rss file. That's why you have to add target="_self" or _blank to the link to disable the internal routing. (This requires a small patch for the rss button, which has no icon currently... for whatever reason.)

Do you think it is useful now to let more people test the snippet service? I would prefer if the snippet service already runs on the new server for further tests.

Yes, I think so, but I first want to make sure the jenkins build script works with what I installed so far. We also need a service setup for the backend as it might crash.

markus2330 commented 7 years ago

I guess that is a good info for not-so-angular people.

Yes, that are very good news! Please update the README.

even if you request something like the feed.rss file

Please also explain (in the README) what "something like" is. For which links is target="_self needed?

Yes, I think so, but I first want to make sure the jenkins build script works with what I installed so far. We also need a service setup for the backend as it might crash.

Yes, let us discuss these issues in #1161 please.

Namoshek commented 7 years ago

Please also explain (in the README) what "something like" is. For which links is target="_self needed?

Meant are non-internal links, even if they target resources on the same server. If a link is external, it obviously is routed as such. But if a link is relative or has the same base URL as the frontend as target, it would get routed internally (by the JS app, not by the browser) without target.

target="_self" targets the current browser window/tab while target="_blank" opens a new window/tab.

Namoshek commented 7 years ago

Links from all "big points"

Where should we link them to?

markus2330 commented 7 years ago

Where should we link them to?

Global configuration database: without link Human readable conf files: mount tutorial plugins/tools: to startpage of plugins/tools batteries included: link individual points configuration specification: validation tutorial code generation: src/tools/gen

Namoshek commented 7 years ago

I added one or two more links than in your suggestions, see 8e7b649a2e8f38b4a3b7db815f0ba59a645e6530.

markus2330 commented 7 years ago

Thank you! Looks great with links now! There are quite some 404 now, however, e.g. storage plugins.

And it would also be nice if the logo+title would be a link, too?

Namoshek commented 7 years ago

Doesn't look good with the logo/title being a link, I tried it. That's also why I tweaked some of the suggestions a little bit.

404 are interesting, I tried all links locally. Must investigate that further...

markus2330 commented 7 years ago

3.2 MB application.js? (answer: it is a bundle containing all used JS dependencies, so instead of many files we only have one large one)

Do we really need all of this 3.3MB? What about stripping away comments and whitespace? (Not sure if it is worth it: we actually should preserve the license information)

I added/changed some points above. Do you need information which points in future? Or only a ping that I added something?

This time it is:

Namoshek commented 7 years ago

line length (when there is a line wrap/new line) quite different across main page

Now I got you. Some texts are block-text, others are not. I'll adjust it.

Snippet Sharing is two columns on purpose by the way, because if it was only one column with that much text, it would be a very high column compared to the other columns. And I think it is good for the optics, not having absolutely everything in three equal columns.

When going to a link, e.g. https://community.libelektra.org/devgettingstarted/license it is unclear where you are ("Development" should be highlighted in this case)

That is actually not so easy. I've no idea if I can make this check on a dynamic amount of subsections.

is there an easy, non-disturbing way to have a "show page at github" link on every page? I needed this twice already.

I think the issue is rather placement than feasibility.

markus2330 commented 7 years ago

Some texts are block-text, others are not. I'll adjust it.

Thank you, you find quite many issues by us talking past each other ;)

Snippet Sharing is two columns on purpose by the way, because if it was only one column with that much text

That is what I meant ;) (which also causes the longer lines). But ok you are right in two ways: (1) it really is nicer to not have everything absolute symmetric, (2) the snippet service really earns the double space!

I think the issue is rather placement than feasibility.

Yes.

I found one more issue (updated above): back button does not work when following links with redirect, e.g. when visiting tools: https://community.libelektra.org/tools/

Namoshek commented 7 years ago

Yeah I noticed this too already, but I'm not sure if there is an easy way around it.

markus2330 commented 7 years ago

Yeah I noticed this too already, but I'm not sure if there is an easy way around it.

Then we should avoid such redirections? (add README.md in tools?)

I added some more minor points:

Namoshek commented 7 years ago

back button does not work when following links with redirect, e.g. when visiting tools.

This does actually only happen when using a normal href link, it does work properly for ui-sref links. I'll change the in-text links so it should work.

When going to a link, e.g. https://community.libelektra.org/devgettingstarted/license it is unclear where you are ("Development" should be highlighted in this case)

Don't see a way to implement that, sorry. But I think it is very minor anyway, considering we only have two docu sections with numerous subsections.

clicking on login possible even though backend is down, we should immediately say that login won't work

Not worth making a preflight call for that... it should not happen in future anyway (and if, then only for very few seconds).

markus2330 commented 7 years ago

Don't see a way to implement that, sorry. But I think it is very minor anyway, considering we only have two docu sections with numerous subsections.

Do you have some other idea how to give a clue where someone is?

Why not giving the two docu sections an identifier within the link, e.g.: https://community.libelektra.org/dev/gettingstarted/license instead of https://community.libelektra.org/devgettingstarted/license and make the highlight depending on the current URL (/dev/ part)?

Not worth making a preflight call for that... it should not happen in future anyway (and if, then only for very few seconds).

Hopefully ;)

I also added what we found in #1187 (error+success at same time).

Namoshek commented 7 years ago

Do you have some other idea how to give a clue where someone is?

There are the breadcrumbs on the bottom. The problem is that I cannot match the top-section with the sub-sections easily. I will think about it, maybe I come to a solution, but don't expect too much.

Why not giving the two docu sections an identifier within the link, e.g.:

Not going to work with the current structure file (and I won't change this for something like that, there are too many major variables involved).

markus2330 commented 7 years ago

Thanks for cleaning up the ticket!

There are the breadcrumbs on the bottom.

Ok, but they have basically the same problem: you do not know in which section you are in.

I will think about it, maybe I come to a solution, but don't expect too much.

Thank you!

Not going to work with the current structure file (and I won't change this for something like that, there are too many major variables involved).

Having the whole path someone clicked in the URL also has other advantages (e.g. for typing urls and "up" buttom works, but not many browsers implement this nowadays).

Btw. https://webbkoll.dataskydd.net/en/results?url=https%3A%2F%2Fcommunity.libelektra.org%2F gives us very good results.

It only recommends to enable HSTS (always try https). I added it to the ticket.

Namoshek commented 7 years ago

Having the whole path someone clicked in the URL also has other advantages (e.g. for typing urls and "up" buttom works, but not many browsers implement this nowadays).

Not saying it doesn't make sense, but it is no easy change at all. It involves changing basically all grunt tasks, several scripts and HTML code.

Namoshek commented 7 years ago

I added HSTS in the libelektra.org config (with inclusion for all subdomains), so the effect will probably only visible after the change to the new domain.

Why is a plugin required for RSS? Do you generate atom or RSS?

I'm generating atom (the one you used before). The browser can certainly handle the RSS without plugin, but the icon in the URL bar was only shown with a plugin in firefox (this is no standard-feature).

markus2330 commented 7 years ago

I added HSTS in the libelektra.org config (with inclusion for all subdomains), so the effect will probably only visible after the change to the new domain.

Thank you!

I'm generating atom (the one you used before). The browser can certainly handle the RSS without plugin, but the icon in the URL bar was only shown with a plugin in firefox (this is no standard-feature).

Ahh, you mean a different icon. I mean the one when you press on "Open menu". This one works for me without issues and without plugins.

Namoshek commented 7 years ago

Ah, now I see the default icon too (on the very right). And there is also one in the bookmarks menu!

markus2330 commented 7 years ago

Three small issues:

we can change AUTHORS to markdown if you prefer.

Namoshek commented 7 years ago

link doc/AUTHORS for "ElektraInitiative" bottom right

I thought you want the copyright to link to the license? There is a link to the license in the sentence on top ("BSD License") already, so we can change it.

Where do we put the authors file in the docu? (Yes, we have to link it somewhere in order for it to be available.)

time zone for "Last update:"

Not necessary, it is calculated as local time already (and the date format is also aware of the locale).

blinking should stop when finally is there (or even remove bar, too)

Going to look into it.

markus2330 commented 7 years ago

I thought you want the copyright to link to the license? There is a link to the license in the sentence on top ("BSD License") already, so we can change it.

Yes, the (C) should point to the licence, the ElektraInitiative to authors!

Where do we put the authors file in the docu? (Yes, we have to link it somewhere in order for it to be available.)

Development?

Not necessary, it is calculated as local time already (and the date format is also aware of the locale).

Thank you, that is nice. Timezone is useful nevertheless. For me it shows 1h wrongly. And tor/proxy users will get anything.

blinking should stop when finally is there (or even remove bar, too) Going to look into it.

Thanks, someone else was disturbed by it, too ;)

Namoshek commented 7 years ago

Yes, the (C) should point to the licence, the ElektraInitiative to authors!

No one will notice the (c), it is impossible to spot that this are different links... actually it is uncommon to have the copyright point to something at all.

Thank you, that is nice. Timezone is useful nevertheless. For me it shows 1h wrongly. And tor/proxy users will get anything.

Have to see if there is a function for some better output. On my system the time is correct though, I executed the build script for the frontend around this time.

markus2330 commented 7 years ago

No one will notice the (c), it is impossible to spot that this are different links... actually it is uncommon to have the copyright point to something at all.

Not really important if someone misses the link, it is also in the title bar. I would nevertheless do it that way.

Have to see if there is a function for some better output. On my system the time is correct though, I executed the build script for the frontend around this time.

Ok, maybe this was the case for me, too. If you do not find something adding the timezone, at least note that it is "local".

markus2330 commented 7 years ago

I moved some fixed issues to the archive and added some other issues.

Namoshek commented 7 years ago

have links to plugins (open in new tab) when selecting a plugin (share/convert)

What does this mean?

markus2330 commented 7 years ago

When I select input/output/upload format, it would be great if I can get infos about the plugin I selected. Basically it is enough to provide a link to the plugin page.

If this is not possible, we should at least add some general information and link to the plugin page.

Namoshek commented 7 years ago

It will be a dirty hack concerning plugin variants, but it should work.

markus2330 commented 7 years ago

Thank you, the login issues are more important, though. (Maybe it is just a wrong error message I get?) Would be great if browsers could remember user+pass. I updated the list in the top post.

Namoshek commented 7 years ago

firefox is not able to autocomplete login (user+password)

Works for me properly in FF 50.0.2. I could imagine it being a policy issue or something else. Or maybe you somewhen clicked "never ask again"?

login fails with misleading error messages (connection failed)

Not misleading, it's the truth. You can always check the response; this message does normally only appear on 500 errors or if the request timed out (which happens almost immediately if the server is down).

markus2330 commented 7 years ago

Works for me properly in FF 50.0.2. I could imagine it being a policy issue or something else.

Might be related to the "connection" issue.

Not misleading, it's the truth. You can always check the response; this message does normally only appear on 500 errors or if the request timed out (which happens almost immediately if the server is down).

I mean misleading the in the sense that: the request might have crashed the server. And shouldn't we at least separate 500 to timeouts?

Namoshek commented 7 years ago

No, we don't know the difference. apache also throws 500 if the backend is down, I can't influence that.

markus2330 commented 7 years ago

No, we don't know the difference. apache also throws 500 if the backend is down, I can't influence that.

I mean the difference if the frontend gets a 500 or gets nothing. If we get 500 we know it is not a connection issue on the client side.

Works great, a huge thanks! Maybe you can add some text/hint so that people know where this link leads to.

Namoshek commented 7 years ago

That's why the message hints both possible errors, connection issue or unavailable backend... in the end it doesn't matter and you can quite easily find out what the real error is, if it is relevant for you. Changing it just bloats the code, there is no easy way to intercept this behavior in a central place.

The rest docu seems like it needs data from apiary.io to be able to display anything (which again pulls in google analytics and more).

That's what is generated and there are no options to prevent it (see apiary-client).

markus2330 commented 7 years ago

That's why the message hints both possible errors, connection issue or unavailable backend... in the end it doesn't matter and you can quite easily find out what the real error is, if it is relevant for you.

How can I find out? At least for me it matters a lot: I always need to check manually if the rest-client is running.

And I think it generally of interest if retrying with different data might lead to success.

Changing it just bloats the code, there is no easy way to intercept this behavior in a central place.

It would be enough if we have it at the "public places" (login, snippet transformation).

That's what is generated and there are no options to prevent it (see apiary-client).

Seems like there is commercial interest behind this.

Btw. what are the results of API testing and benchmarking? Did you try something?