wiki:cs/SablonaStrankyProjektu

Version 2 (modified by Zuzana Nevěřilová, 7 years ago) (diff)

--

Šablona stránky projektu

Tato stránka slouží k tomu, aby bylo pro členy CZPJ snadné dodržovat pravidla provozu CZPJ. Každý projekt má mít stránku, která je veřejně přístupná a informuje aktuálně o stavu projektu.

Veřejně přístupná stránka

V adresáři projektu /nlp/projekty/OZNACENI_PROJEKTU vytvořte adresář public_html. V tomto adresáře vytvořte soubor .htaccess, kterým nastavíte přístup ke stránkám projektu.

Aspoň základní informace o projektu by měly být veřejné, .htaccess tedy bude obsahovat řádek:

Allow from all

Pokud chcete mít další části projektu neveřejné, dejte je do podadresáře /nlp/projekty/OZNACENI_PROJEKTU/public_html/NEVEREJNA_DATA a opět pomocí .htaccess nastavte přístup do tohoto neveřejného adresáře.

Bezpečná stránka

Do adresáře /nlp/projekty/OZNACENI_PROJEKTU zkopírujte všechna data potřebná k fungování projektu: zdrojové kódy, konfigurační soubory, případně data (pokud nejsou moc velká). Oproti tomu do adresáře /nlp/projekty/OZNACENI_PROJEKTU/public_html nekopírujte nic, co nechcete, aby někdo zvenku viděl. Typicky v tomto adresáři nesmí být konfigurační soubory obsahující hesla.

Povinné součásti stránky projektu

Stránka projektu může být v češtině, slovenštině nebo angličtině, angličtinu preferujeme. Nemusíte vytvářet jazykové mutace, ale když to uděláte, budeme rádi. V následujícím výčtu jsou povinné součásti stránky projektu.

  • Název projektu
  • Stručný popis projektu
  • Příklad použití (případně screenshot, screencast)
  • Popis, jak aplikaci spustit (popis instalace, popis spuštění z příkazové řádky...)
  • Pokud dáváte k dispozici aplikaci ke stažení a instalaci, můžete poskytnout vzorek dat
  • Nejlepší publikace, které se k aplikaci vztahují (ano, i bakalářská práce je publikace)
  • Changelog
  • Acknowledgement, pokud projekt vzniká v rámci grantového projektu
  • Licence

Attachments (2)

Download all attachments as: .zip