Topic

First Steps

Dec 14, 2006 / pixtur
Nov 22, 2010 / guest
 

Attached files

 
Things to do after successfully installing streber and removing the install-directory:


Installationπ

Streber is all about communicating relevant information with your team and clients. That's why it needs to be installed on a web-server, either in your local company network or accessible on the internet.

You will find Internet Service Providers (ISP's) offering this for as little as 4€/month. With an FTP client you copy all files of the latest stable version to your server, set write-permissions to the directories starting with an underscore. Then you use your preferred browser and request your domain to bring up the installation form. The installation-dialog will ask for access information to your database, and some basic settings. After filling out the required fields the installation will be completed automatically.




Creating a projectπ

After logging in as admin-user, let's proceed by creating a project. For the sake of having an example, let's make a project on managing the design of a new web-site: world-domination.tv.

We go to "Projects" and in the upper right corner we find the page function for creating a "New project".
Addional to a name, we have all kinds of special settings which primarily aim to simplify the user interface for your team-members. If you don't work with software development, you probably don't require features for managing releases and bug-reports. To keep things simple for your team-members, we suggest to disable as many features as you can and activate them later when your team-mates got used to the interface.

Hit submit to complete the creation. This brings up the overview-page of our new project.

General interfaceπ

All pages of streber have a similar layout: On the top you see the header with the sections: Home, Projects, Companies and Search. Right now we are in Projects, and here we are at the overview page of "World-domination". This project has some sub-pages "Topics", "Files", etc. which will be explained later. If we would not have reduced the project-features ealier, this list would be much longer.

On the top right you find functions for the current page. In this case "Edit project", "New task", and "New Topic". We also have a page title, and some boxes. That inform us there nothing have been changed so far and that we are still the only person working on this project.

Topics and dealing with textπ

Let's start by creating a new Topic. In the top right of the project-page click "New topic".

A topic is a mixture between a wiki-page and a forum post. You might already heard the word wiki from wikipedia. It means two things: that you can use a simple syntax to format and structure text. And that the complete history of this text is stored and all changes can be reverted.
Let's enter a title and a text for out topic... (image).

There are a number of easy to learn rules on how to format a wiki-text: lines underlined by ==== or ---- become headings. Lines starting with - or numbers become lists an so on. For details you can always check the complete wiki-syntax.
To complete your Topic press "Submit".

The notice barπ

Maybe you expected a new page to show up now. Instead streber provides us the project overview. Although this might make sense when you create a lot of topics, where is this new topic we just created?
After each modification streber prints the result of the last operation. To make things convient it renders newly created items as links to the new objects.

Here you can see the formatted version in all it's beauty...

Wiki-links and inplace edittingπ

Just like in wikipedia you can use the wiki-syntax to create links to other pages, people or projects. Let's add some links to our text! You might have already noticed the "edit" function in the corner. Of course you could use this to edit the topic an all its gory details, but editing texts is so essential, that there is a much easier way: By adding headings to your wiki-text, it not only gets nicely formatted. Streber also cuts the text into chapters that can be editted in place. When you move the mouse pointer over an editable text, each chapter is slightly highlighted. To edit
a chapter you simply double click and the section is replaced by a text edit field, filled with the wiki text.

Here we insert a new chapter with a couple of links. Links are defined between double square brackets. Let's try our nickname and a couple of topics that might be worth discussing... Submit the changes and view the result:
Our nickname looks like a valid link. But everything else is red! The tool-tip clarifies what is going on here: "No item with this name.. Click to create it". This sounds like we should try it, and just as expected we get the already known form with the title already being filled out. We enter some text with wiki-syntax and submit.

This brings us back to our original topic which now renders the valid link to the other topic.

Documentationπ

All topics together will form our project documentation. To easily navigate between topics, use the documentation box on the right of each topic.


Uploading filesπ

To upload a file to a Topic we use the "Attached files"-box (image). Click on the browse field and select the file on your hard drive. Then click on "Upload" and after a short moment you will get a form asking for the title of this file. Just use the default title and submit the form.

In the topic the uploaded file will be listed as a thumbnail. If you want to see the details you can click on it's item-number, but right now we only want to insert it to our text. Double click the wiki-text and add a new line like:
[[image:6]]
Whereas 6 whould be the image-id.

This is way too large, but we can scale it down with a line like:

[[image:maxsize=100]]
You can check out the wiki-syntax for all the details on how to format images.







No Projects without Peopleπ

Your business data is sensitive information, so you want to make sure who is going to see what. With streber you do this by creating people and assigning them to projects. With normal rights, any person can only see the projects he is being assigned to. Further more he can only see other people if they are also assigned to this project: thus you can easily have two projects on the same server without any of the people ever knowing about the other project. Or ever seeing any people not related to his own project.

Right now we are the only member of the project's team. To add new members we go to the Project-Overview and use the "+"-function below the team list. The list is still empty but we get a small hint to got the "People" and create some.



New Personπ

The form provides all the fields you would expect for contact information. As a matter if fact you are free to use streber as a sort of address-book. But if you want to create a account for somebody to login, we need some additional information: a nickname which is used for logging in (lets call him bob) and a valid email address. Although you could set a password, we strongly advise not to do so. Streber will use the email address to send a notification message with a link to this form. Each person is free to adjust his profile and user-specific settings to his own needs. This shows streber's philosophy of making things easier by trusting in people.

We also set Bob's language to German which will make Streber easier to be used.

Later we will check for mails and login see how streber looks for Bob.
However when creating a new account you have to decide for a user-profile. A profile is a template for user rights and can only be changed by people who have the right to do so: admins and project managers.

Activation email & user passwordsπ

After we complete the form, the new member will find an email in his inbox: this email comes in the language we defined for the account and kindly invites the new member to adjust his settings and to set a password. The link will open the form we saw earlier and now the new member can enter his own password.



Team-membersπ

...

Activation mailπ

See above

Login as developerπ

Changes, comments, another topic, efforts

Request feedbackπ

Login as clientπ

Asks a weird question


The project manager in betweenπ

  • make suggested public
  • answer feedback

Topics become Tasksπ

In streber every single piece of information is an item: topics, projects people, you name it. And for some items your can change the type anytime. You can easily turn a topic into a task that can be assigned to people and milestones. And later, e.g. If this task got too complex, you can that turn it into a "folder" with lots of subtasks.

Sorting things outπ

Depending on the size of your project, you sooner or later should sort your topics and tasks into folders. This will help to group tasks and documentation. Let's change the "design"-topic into a folder and create some sub-topics: go to "design", either at "Documentation" or "topics". On the design page use the "edit topic"-function in the upper right.




Scopeπ

first_steps_03_related_people.pngAs Streber is based on the wiki principle it prefers hiding information over write protection. Since all changes can be reverted anyway the potential damage is low.
Default users have a limited "Scope" that only display relevant data. You could easily have two completely different teams (including clients) on one server without ever knowing from each other. Users see only persons, with which they work in the same projects. And they only see data from project they are assigned to.
  • Go to People and...
  • Create an active user with profile Developer. Check ''Create another person after submit" to...
  • Create an active user with profile Client
  • Go to your Project (either by projects or by the Projects list in your home)
  • Use the "+" icon below the Team-list to add both users at once.
You now have a Team of 3 users. 22




5. create a client-organisation π

  • select the clients-tab
  • create a new client by using the link or the page-function
  • fillout some fields
  • Submit the new client



6. edit projectπ




7. customizingπ

  • to change the default-language from English to German open "customize.inc" and add following line (or remove the "#" at the beginning):
confChange('DEFAULT_LANGUAGE', 'de');

5 Comments

guest:missing some ilustration

8 years ago -

for non sysadmins it would be easier to understand with more ilustrations

pixtur:Antwort auf missing some ilustration

8 years ago

guest:Where can I find the file with portuguese language? In needs improvement.

8 years ago -


guest:perfect

7 years ago -

wow, i love this app.

@?why glasses if one does not want to see?

guest:Gorgeous

7 years ago -

I can't believe how awesome this app is. Thank you to the entire community!