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.
Przy wstawianiu linków do konkretnych sekcji (akapitów) na wybranej stronie, np. Certyfikaty Simple CA ="Aplikowanie, rejestracja i użycie certyfikatu#Certyfikaty Simple CA", należy nazwę strony wraz z tytułem sekcji, rozdzielone znakiem #, podać w opcji Advanced w okienku link. Przy wstawianiu nazwy stron istotne jest zachowanie znaków spacji pomiędzy wyrazami oraz braków spacji pomiędzy #.
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
Dla kogo jest przeznaczona, jakie najważniejsze możliwości oferuje?
Usługa jest przeznaczona dla biologów prowadzących badania nad kolistymi DNA w tym dla tych, którzy w swoich badaniach wykorzystują plazmidy. Oprogramowanie Vector NTI Advance jest zintegrowanym, wielofunkcyjnym pakietem aplikacji do analizy sekwencji DNA, RNA i białek. Jest jednym z najlepszych tego typu narzędzi dostępnych obecnie na rynku i zapewnia doskonałą integrację, zarządzanie danymi i skalowalność.
Aktywowanie usługi
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ć.
Aby skorzystać z usługi Vector NTI należy mieć aktywne konto w plgrid. Szczegóły uzyskania takiego konta znajdują się tutaj.
Do usługi Vector NTI może uzyskać dostęp każdy użytkownik Plgrid, który jest użytkownikiem usługi Grid Dziedzinowy Biologia oraz usługi chmurowej Obliczenia Kampusowe Platon. W celu uzyskania dostępu do tych usług należy wejść na stronę http://portal.plgrid.pl a następnie zalogować się podając swój identyfikator plgrid (np. plgfilutowska) i hasło do portalu po czym z górnej belki zawierającej menu wybrać opcję „Moje konto” (czwarta opcja od lewej strony). W prawej kolumnie ukaże się Katalog usług dostępnych dla danego użytkownika.
Z katalogu usług należy wybrać kategorię: Usługi chmurowe, a następnie „rozwiń”, ukaże się lista usług w tej kategorii, wśród nich będzie usługa o nazwie „Obliczenia Kampusowe – PLATON” a tuż obok link zatytułowany „aplikuj o usługę”.
Po kliknięciu ukaże się formularz. W formularzu należy z listy rozwijanej wybrać instytucję z jaką użytkownik jest afiliowany oraz wpisać dwukrotnie hasło do usługi. Po wypełnieniu formularza należy kliknąć przycisk „zarejestruj”.
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.
Overview
Content Tools