Opened 5 years ago

Closed 5 years ago

#3466 closed task (complete)

Documentation for keactrl is needed.

Reported by: marcin Owned by: marcin
Priority: medium Milestone: Kea0.9
Component: documentation Version:
Keywords: Cc:
CVSS Scoring: Parent Tickets:
Sensitive: no Defect Severity: N/A
Sub-Project: DHCP Feature Depending on Ticket: 3418
Estimated Difficulty: 0 Add Hours to Ticket: 1
Total Hours: 7 Internal?: no

Description

This is a followup ticket to #3422 and must be implemented after #3422 is done.

The #3422 introduces a script to start, stop, reconfigure and get status of Kea processes. At the time of implementation of this script there were ongoing changes to the Kea documentation that should be completed before keactrl documentation can be introduced.

This ticket is about adding appropriate documentation into the Kea User Guide (and maybe developer's guide) about the new script.

Subtickets

Change History (7)

comment:1 Changed 5 years ago by tomek

  • Milestone changed from Kea-proposed to Kea0.9

comment:2 Changed 5 years ago by marcin

  • Owner changed from UnAssigned to marcin
  • Status changed from new to accepted
  • Type changed from defect to task

comment:3 Changed 5 years ago by marcin

  • Feature Depending on Ticket changed from 3422 to 3418

comment:4 Changed 5 years ago by marcin

  • Add Hours to Ticket changed from 0 to 6
  • Owner changed from marcin to UnAssigned
  • Status changed from accepted to reviewing
  • Total Hours changed from 0 to 6

I have added a new chapter in the Kea Administrator guide. I also created a man page for keactrl.

I wonder if it needs a ChangeLog entry as there are more documentation tickets so maybe aggregate them in a single entry?

This ticket is now ready for the review.

comment:5 Changed 5 years ago by stephen

  • Owner changed from UnAssigned to stephen

comment:6 Changed 5 years ago by stephen

  • Owner changed from stephen to marcin

Reviewed commit 38835b6214c961cd0d5a7602e3342ea355b2535d

All seems OK. I've made a number of edits to the documentation: if you're happy with them, please merge.

I wonder if it needs a ChangeLog entry as there are more documentation tickets so maybe aggregate them in a single entry?

A ChangeLog entry is needed for the documentation and it does make sense to have a single entry for all documentation changes. Please make a note on any outstanding documentation tickets in this milestone to check for the ChangeLog when a commit is made: it will be too easy for every ticket to defer the addition of a ChangeLog entry to another ticket with the result that nothing gets added.

comment:7 Changed 5 years ago by marcin

  • Add Hours to Ticket changed from 6 to 1
  • Resolution set to complete
  • Status changed from reviewing to closed
  • Total Hours changed from 6 to 7

Ok, I updated the relevant tickets as suggested.

Also, merged with commit fa9570d19c73cbe7effc75589b7eb855c411f6a3

Note: See TracTickets for help on using tickets.