Poniższy szablon należy odpowiednio uzupełnić.

  • Układ należy zachować (z dopuszczeniem minimalnych modyfikacji).
  • Opis nie powinien przekraczać 10 stron przeciętnego ekranu laptopa.
  • W razie potrzeby należy założyć podstrony (na końcu z rozdziałem "Co dalej?" i odnośnikiem do kolejnego rozdziału dokumentacji).
  • Język opisu - polski. W sytuacji, gdy zasadnicza dokumentacja usługi ma być po angielsku, w tym rozdziale powinny znaleźć się podstawowe informacje pozwalające zorientować się w zaletach usługi i zgrubnie w wymaganych krokach do jej uruchomienia.
  • Uprawnienia do odczytu strony (Tools/Restrictions) powinny być ustawione na "Confluence-users" w trakcie pisania dokumentacji, inaczej będzie widoczna od razu dla osób niezalogowanych.
  • Pytania dotyczące systemu dokumentacji: Hubert Siejkowski,
  • Pytania dotyczące Podręcznika Użytkownika: Unknown User (plgfilocha).

Wstawianie odnośników do innych stron podręcznika

Przy wstawianiu linków do stron wewnętrznych Podręcznika użytkownika (np. certyfikat="Aplikowanie, rejestracja i użycie certyfikatu"' założenie konta="Zakładanie konta w portalu"; Pomoc="Gdzie szukać pomocy") należy w trybie edycji strony:

  • wpisać tekst, pod który będzie podpięty link
  • zaznaczyć tekst
  • wstawić link (Ctrl+K lub ikona Link na pasku narzędzi)
  • wybrać opcję Search z lewej strony okna Insert Link
  • w pasku po prawej wpisać tytuł strony (lub zacząć wpisywać tytuł i wybrać właściwą stronę z pojawiających się podpowiedzi)
  • zatwierdzić wybraną stronę opcją Insert w prawym dolnym rogu

Efekt powyższego opisu można zobaczyć klikając lewym klawiszem myszki (w trybie edycji strony) na dowolny link w tym oknie informacji. Pojawi się pole, w którym do wyboru będzie opcja Edit, którą klikamy. Pojawi się okno Edit link, z aktywnym polem Search i nazwą strony wewnętrznej podręcznika.


LINKI ZEWNĘTRZNE

Linki zewnętrzne np. do strony PL-Grid wstawiamy w oknie Insert Link (Ctrl+K) w opcji Web Link.

Pomoc w pisaniu stron w Confluence: https://confluence.atlassian.com/display/DOC/Using+the+Editor

 

Krótki opis usługi/Introduction

Dla kogo jest przeznaczona, jakie najważniejsze możliwości oferuje?

Aktywowanie usługi/Registration, first steps and services activation

  1. Registering as a PL-Grid user: please consult the Registration steps section of the user manual (EN) or Podręcznik użytkownika (PL)
    1. if you are a foreigner, be prepared that you will need your Polish collaborator to confirm your identity - for the PL-Grid operatives to contact the correct person for the confirmation, you will need to obtain the so-called OPI number from that person
    2. alternatively, you may try to look that person up in the Polish science people database (Polish language only, I'm afraid) to obtain the needed OPI number
    3. in case you are a Polish scientist, but you do not have your own OPI number, the one of your supervisor's will suffice
    4. finally, your own OPI  number is enough, if you have one.
  2. Requesting a certificate - again, please follow the user manual (for English version, or Aplikowanie, rejestracja i użycie certyfikatu section in Polish version of the manual) for detailed instruction on how to automatically obtain your own PL-Grid certificate. Here, you will be asked to supply a certificate guard passphrase - please remember what you type as you are going to need it later on.
  3. Requesting access to services; you will need to activate access to couple of services:
  4. Both services should be activated automatically for you, in a couple of minutes, and you will be informed of that fact by an e-mail. Then you are ready to navigate to https://galaxy.plgrid.pl/ in order to start your first Galaxy session.

  5. The service will use the infrastructure resources grant you have set as your default (it might be your personal resources grant).

Old Polish: Należy wykonać następujące kroki:

  1. Rejestracja portalu PL-Grid i założenie konta użytkownika. 
  2. Zalogowanie do portalu PL-Grid. 
  3. Wygenerowanie certyfikatu simpleCA - Aplikowanie, rejestracja i użycie certyfikatu
  4. W zakładce Moje konto należy odnaleźć i aplikować o następujące usługi:
    1. Usługi globalne: Globalny dostęp QosCosGrid
    2. Platforma dziedzinowa:Complex Networks i wszystkie 3 usługi widoczne pod nią.

Co należy aktywować, aby móc skorzystać z usługi? (Założenie konta, certyfikat, grant?, aktywacja konkretnych usług w portalu). Należy pamiętać o istnieniu rozdziałów ogólnych podręcznika, do których warto się odwołać.

Ograniczenia w korzystaniu (podsekcja opcjonalna)

Tutaj wpisujemy specjalne zasady korzystania z usługi jeśli takowe są np. konieczność ustawienia grantu domyślnego, zakaz uruchamiania intensywnych zadań na UI itp. Jeśli takowych nie ma to należy tę podsekcję usunąć.

Pierwsze kroki

Koniecznie z przykładowymi zrzutami ekranu lub fragmentami kodu.

Zaawansowane użycie

Ewentualnie jako osobny podrozdział.

Gdzie szukać dalszych informacji?

Strony zewnętrzne (jeśli są), odnośnik do helpdesku lub strony dokumentacji o pomocy.

Można też dodać sekcję "Co dalej?" ze wskazaniem (odnośnikiem) do dalszej części dokumentacji, o ile jest wymagana.