search

openSUSE / osem

Open Source Event Manager. An event management tool tailored to Free and Open Source Software conferences.
http://osem.io
MIT License
871 stars 491 forks source link

Instructions for site admins to work on OSEM. #1548

Open shlok007 opened 7 years ago

shlok007 commented 7 years ago

The idea is to create instructions in the hosted version of OSEM that will help the site admins know how to start creating conferences after signing up. It can involve instruction to create their first organization, assign organization admins and conferences as well

Points that can be covered:

Now I could come with two possibilities till now:

  1. Create a set by step wizard for site administrators to create new organization and assign organization administrators by rendering form partials in the right places for each step and instructions covering the above points along with it.
  2. A simpler way could be just instructions attached with screenshots and links to the appropriate page.

The site admin probably don't want to see the instruction/wizard every time he/she signs in, so instead of displaying the instructions on the landing page, I suggest we add a separate view for it.

Once we decide which one among the above two possibilities( if any! ) we will be using, I'll get ready with the layouts/wireframes as well.

Please do let me know any ideas or suggestions regarding this issue!

Edit: If are only writing instructions, then the other option can be to update the dcumentation of the project by mentioning them in INSTALL.md and not have a separate view, as site admins will be the one to host the OSEM and hence, will have access to the code.

differentreality commented 7 years ago

We should definitely add instructions, somewhere. And it sounds like a good idea to point to those instructions on our INSTALL.md and/or README.md

Is this still the workflow you are working with? When I am a site admin, and I have deployed OSEM for the very first time, when signing up I am redirected to admin area, where I can see the link to create a new conference (or now a new organization I assume).

shlok007 commented 7 years ago

We should definitely add instructions, somewhere. And it sounds like a good idea to point to those instructions on our INSTALL.md and/or README.md

Perfect! Sounds like the simplest solution.

When I am a site admin, and I have deployed OSEM for the very first time, when signing up I am redirected to admin area, where I can see the link to create a new conference (or now a new organization I assume).

I was hoping we can redirect to conferences dashboard, admin/conferences#index ( the way it is now ) as it displays the various insights into all the conferences. The admin/organizations#index will have nothing but a list of organizations for now. We can have a link to create new organizations somewhere in the admin/conference#index itself.

differentreality commented 7 years ago

Sounds good to me!

shlok007 commented 7 years ago

I have added few instructions here: https://github.com/shlok007/osem/blob/update-installmd/INSTALL.md#setting-up-osem-for-the-first-time

differentreality commented 7 years ago

The instructions seem to be about the hosted version, so not really about installation. How about we move this guide completely on our wiki, and just mention something like 'You can also use our hosted version directly, read more on our wiki'

In the screenshot it shows in the drop down menu that you have the items Users and Revision History, I don't think this will happen with the actual users, right?

shlok007 commented 7 years ago

Let's do that! We use README.md because it gives a preview in our github repository too. I was not sure why are we using INSTALL.md when we have wiki available on github! :sweat_smile:

In the screenshot it shows in the drop down menu that you have the items Users and Revision History, I don't think this will happen with the actual users, right?

The preview is for site administrators who have access to both Users and Revision History. Sorry, do you have a problem with permissions to access those items by site administrators or the presence of those links in the navbar?

differentreality commented 7 years ago

Right, it's for site admins, sorry!

INSTALL.md is for production environment. The process for development is different, so those things are split up. I'd suggest we don't put too much data on the README.md (text, instructions, screenshots) that we make it huge.

olea commented 6 years ago

@shlok007 About the installing instructions, for the OpenID thing: AFAIK a callback URL is required to register a new application at providers, but this URL is not documented. Am I wrong?

differentreality commented 6 years ago

@olea that's not specific to site admins, and hosted version, though.

https://github.com/openSUSE/osem/blob/master/INSTALL.md#openid Indeed we should mention about the callback url, which is in the format of https://osem.example.com/accounts/auth/github/callback (assuming this is for github)