Opened 5 years ago

Closed 5 years ago

#3468 closed enhancement (complete)

Convert Kea6,D2 sections in User's Guide to JSON

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

Description

This is a follow-up to #3418 which was split up into two tickets.

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

When creating a changelog entry for the Kea 0.9 documentation please include the #3466 in this ChangeLog entry

comment:3 Changed 5 years ago by tomek

  • Owner changed from UnAssigned to tomek
  • Status changed from new to assigned

comment:4 Changed 5 years ago by tomek

  • Owner changed from tomek to UnAssigned
  • Status changed from assigned to reviewing

The code is ready for review. The Logging section is updated in a separate ticket.

Proposed ChangeLog? entry:

8XX.	[doc]		tomek
	DHCPv6 and DDNS sections in Kea Administrator Reference Manual
	has been updated. Usage of keactl has been documented.
	(Trac #3468, git abcd)
	(Trac #3466, git fa9570d19c73cbe7effc75589b7eb855c411f6a3)

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 tomek

Reviewed commit 5f262cb1e8188db8f13a5f7ab35e9c7e304c293e

I've made a number of small nit-picking changes, partly to the changes done in this ticket, but also to other text in the files that were altered. These include:

  • Ensuring that the format of the lists explaining map elements is consistent.
  • Ensured that the order of the elements in the lists explaining map elements is the same as the order of the elements in the example they are describing.
  • Changing "Dhcp4" to "Dhcp6" (and vice-versa) in appropriate places.
  • Putting quotes around true and false when these are used as values of a JSON element.
  • Adjusted some text to make it sound better.

Please review these changes. If you are happy with them, go ahead and merge.

ChangeLog
The suggested ChangeLog entry looks OK.

comment:7 Changed 5 years ago by tomek

  • Resolution set to complete
  • Status changed from reviewing to closed

As discussed on jabber, I checked that "true", "false", 0, 1, "0" and "1" are not accepted where boolean is expected. At least not in a general case. So I reverted those changes in the documentation, removed paragraph suggesting that it's ok (I'm not sure where it came from, perhaps there are isolated cases where additional logic handles interger, string to boolean conversions) and created #3506 for that.

The changes are now merged to master. Thanks for your review. Closing ticket.

Note: See TracTickets for help on using tickets.