Task #4236

Reorganize content on https://mentat.cesnet.cz and https://csirt.cesnet.cz/cs/services/mentat web pages

Added by Jan Mach 7 months ago. Updated 5 months ago.

Status:ClosedStart date:07/27/2018
Priority:UrgentDue date:09/30/2018
Assignee:Pavel Kácha% Done:

100%

Category:Documentation
Target version:2.1

Description


Related issues

Related to Mentat - Task #4114: Report content design and adjustments Closed 05/31/2018

History

#1 Updated by Jan Mach 7 months ago

  • Description updated (diff)

#2 Updated by Pavel Kácha 7 months ago

  • Related to Task #4114: Report content design and adjustments added

#3 Updated by Jan Mach 7 months ago

  • Target version changed from Future to 2.1

#4 Updated by Pavel Kácha 5 months ago

  • Due date set to 09/30/2018

#5 Updated by Pavel Kácha 5 months ago

  • Priority changed from Normal to Urgent

#6 Updated by Jan Mach 5 months ago

  • Status changed from New to In Progress
  • % Done changed from 0 to 50

I have just finished content reorganization on https://mentat.cesnet.cz. It now contains current information both in czech and english languages, but only information that is relevant to Mentat system as an open project. The information is kept as brief as possible with many links into the autogenerated, full and official documentation hosted on our automated build system https://alchemist.cesnet.cz.

All information related to Mentat system as a service operated by CESNET-CERTS security team for CESNET2 network users will be moved to separate webpage https://csirt.cesnet.cz/cs/services/mentat. This still needs to be done.

#7 Updated by Jan Mach 5 months ago

  • % Done changed from 50 to 70

I have performed first revision of content on https://csirt.cesnet.cz/cs/services/mentat:

#8 Updated by Jan Mach 5 months ago

  • % Done changed from 70 to 90

More webpage content improvements, mostly on page https://csirt.cesnet.cz/cs/services/mentat/webui. Revised the page content and added few images of web interface. I did not however went too far in describing the interface, since we will now focus on the development and many things will probably change or will be easier to reach, so the manual could get outdated very soon. I will perform one more revision of the whole content and then consider this task to be done. Some additional content improvements will be done as necessary.

#9 Updated by Jan Mach 5 months ago

  • Status changed from In Progress to Resolved
  • Assignee changed from Jan Mach to Pavel Kácha
  • % Done changed from 90 to 100

I have done another revision of the web pages and now consider this issue resolved. There are still possibilities to improve the documentation, but for now all relevant information should be present. Minor tweaks can be done as necessary, improvements of documentation regarding the web interface will be better done later, when we fine tune it little bit more.

#10 Updated by Pavel Kácha 5 months ago

  • Status changed from Resolved to In Progress
  • Assignee changed from Pavel Kácha to Jan Mach

I think there is still need to add something like “Get involved” or “Contribute” page, with big fat link to https://alchemist.cesnet.cz/mentat/doc/development/html/_doclib/development.html (however rather from production branch), and with a few sentences about how to actually send patches/pull requests, how and when to get access to repo, etc. Please, think out what would suit you, as most times you will end up to be the reviewer.

Ideas:
  • casual contributors - git send email, git am
  • verified contributor - access to git
    • small fixes/changes can go to devel
    • specific features into their own branches like “feature-XXX”
    • long running features/cooperation/own playgrounds into “user-XXX” branch

However, how to guard master/release branches? only “initiated ones” should be able to merge to release and master.

#11 Updated by Jan Mach 5 months ago

  • Status changed from In Progress to Resolved
  • Assignee changed from Jan Mach to Pavel Kácha

Done. Your remarks made sense, so I have not changed much in your proposal. The only thing that got changed was, that I would like to do all the merging to devel, release or master branches to have better control. Even the devel branch is now quite important because of the fact, that it is connected to our build system and code gets directly released to development servers. Some minor updates on the web pages are possible, I would however like to put most of the documentation to Alchemist, to avoid duplication of information.

#12 Updated by Jan Mach 5 months ago

  • Status changed from Resolved to Feedback

Please close the issue in case you approve the current state of the web pages.

#13 Updated by Pavel Kácha 5 months ago

  • Status changed from Feedback to Closed

Also available in: Atom PDF