Opened 6 years ago

Closed 5 years ago

#3429 closed task (complete)

Final proof-reading of Kea User's Guide

Reported by: tomek Owned by: jreed
Priority: low Milestone: Kea0.9.1beta
Component: documentation Version: git
Keywords: Cc:
CVSS Scoring: Parent Tickets:
Sensitive: no Defect Severity: N/A
Sub-Project: Core Feature Depending on Ticket:
Estimated Difficulty: 0 Add Hours to Ticket: 4
Total Hours: 11 Internal?: no

Description

That's a follow up ticket to #3418 and should be completed as one of the last tickets. Once all changes are in place, we should do final proofreading, before declaring the User's Guide ready.

Subtickets

Change History (19)

comment:1 Changed 5 years ago by tomek

  • Priority changed from medium to low

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

This ticket should wait till the following ones are done:

  • DHCPv6, DDNS sections (will be covered in newly created #3468)
  • starting/stopping the servers (will be covered in #3466)
  • logging configuration (will be covered in #3427)
  • replace DNS with DHCP examples (#3397)

comment:4 Changed 5 years ago by jreed

  • Owner set to jreed
  • Status changed from new to assigned
  • Sub-Project changed from DHCP to Core

comment:5 Changed 5 years ago by jreed

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

I pushed over ten commits all into the trac3429 branch. This has little technical change. Please see the commit logs for each commit. http://git.kea.isc.org/cgi-bin/cgit.cgi/kea/log/?h=trac3429

Last edited 5 years ago by jreed (previous) (diff)

comment:6 Changed 5 years ago by marcin

  • Owner changed from UnAssigned to marcin

comment:7 Changed 5 years ago by jreed

  • Add Hours to Ticket changed from 0 to 7

comment:8 follow-ups: Changed 5 years ago by marcin

  • Add Hours to Ticket changed from 7 to 0
  • Owner changed from marcin to jreed

Reviewed commit 2738aea5591f60bb2d9671879b0e3bfae31af314

All modifications are acceptable. I just made a few minor corrections.

Question regarding section ''Download Tar file'':

The Kea release tarballs may be downloaded from: http://ftp.isc.org/isc/kea/ (using FTP or HTTP)

This link returns error 404. Is this because we haven't uploaded anything yet? Also, should this be http://ftp.isc.org/isc/kea/ for HTTP and ftp://ftp.isc.org/isc/kea/ for FTP?

Additional comments not related to your modifications as a result of reading the document line by line up to the sections about DHCPv4 server configuration. I didn't read the rest of the document as we agreed to cherry-pick changes to the beta-release branch.

Supported Platforms: This list seems to be outdated. For example it doesn't mention Fedora or RHEL. I am not sure if it should include the most recent versions of the OSes, all versions or the latest versions. Currently it is a mix of all of those.

Quick start guide for DHCPv4 and DHCPv6 services: Should this section point to the system specific notes about installing Kea to provide a reference what configuration flags are typically used?

Building Requirements: The list of compilers is outdated. I think we have tested it with at least GCC 4.8 and Clang 3.2 distributed with FreeBSD10? Not sure about the Sunstudio version.

comment:9 Changed 5 years ago by marcin

  • Add Hours to Ticket changed from 0 to 4
  • Total Hours changed from 0 to 11

comment:10 in reply to: ↑ 8 Changed 5 years ago by jreed

Replying to marcin:

This link returns error 404. Is this because we haven't uploaded anything yet? Also, should this be http://ftp.isc.org/isc/kea/ for HTTP and ftp://ftp.isc.org/isc/kea/ for FTP?

It should be fixed when Wlodek or I upload the files. If not the docs will be wrong for beta. I will just keep it as http for now since they may be browsing the docs by HTTP already.

comment:11 in reply to: ↑ 8 ; follow-up: Changed 5 years ago by jreed

Replying to marcin:

Quick start guide for DHCPv4 and DHCPv6 services: Should this section point to the system specific notes about installing Kea to provide a reference what configuration flags are typically used?

Not sure about what this means.

comment:12 in reply to: ↑ 8 Changed 5 years ago by jreed

Replying to marcin:

Supported Platforms: This list seems to be outdated. For example it doesn't mention Fedora or RHEL. I am not sure if it should include the most recent versions of the OSes, all versions or the latest versions. Currently it is a mix of all of those.

...

Building Requirements: The list of compilers is outdated. I think we have tested it with at least GCC 4.8 and Clang 3.2 distributed with FreeBSD10? Not sure about the Sunstudio version.

yes let's fix this prior to the final release. Thanks for the reviews and improvements.

comment:13 Changed 5 years ago by jreed

I merged the changes to master. I will ask for these many changes to cherry-picked to the beta branch.

I am fine with closing this ticket and opening a new ticket for other changes and further review prior to the final 0.9.

comment:14 in reply to: ↑ 11 Changed 5 years ago by marcin

Replying to jreed:

Replying to marcin:

Quick start guide for DHCPv4 and DHCPv6 services: Should this section point to the system specific notes about installing Kea to provide a reference what configuration flags are typically used?

Not sure about what this means.

In other words, should the guide contain a link to this

http://kea.isc.org/wiki/SystemSpecificNotes

?

comment:15 Changed 5 years ago by tomek

  • Version set to git

Just a minor issue that should be corrected: section 8.3 says that DHCP-DDNS does not support TSIG. It does.

Also, DHCP-DDNS daemon should have Supported standards section. If you feel it's not appropriate to do this as part of this ticket, feel free to create a separate ticket.

comment:16 Changed 5 years ago by tomek

Removed note about TSIG not being supported, added link to System Specific Notes.

We have code freeze in couple hours. On a call today I volunteered to deal with this ticket. I did so, without realizing that there is a branch with changes, so apologies if I stepped into someone else's work.

Anyway, I merged this code to master, but it seems that majority of changes were on master already.

Will discuss this on Jabber tomorrow.

comment:17 Changed 5 years ago by tomek

  • Milestone changed from Kea0.9 to Kea0.9.1

comment:18 Changed 5 years ago by tomek

Not sure if there is anything left to do there, moving to 0.9.1, as 0.9 milestone is about to be closed.

comment:19 Changed 5 years ago by tomek

  • Resolution set to complete
  • Status changed from reviewing to closed
Note: See TracTickets for help on using tickets.