Project

General

Profile

Actions

Feature #12128

closed

Add documentation on how to provision windows

Added by Daniel Helgenberger over 8 years ago. Updated over 8 years ago.

Status:
Closed
Priority:
Normal
Assignee:
-
Target version:
-
Difficulty:
Triaged:
Fixed in Releases:
Found in Releases:

Description

I recently wrote up a documentation [1] on how to achieve this. Greg suggested that it might be possible to add it to the official docs and it would require little change on my end to create a PR against foreman.org.

Questions:
1. Is this welcome currently
2. If yes, where do we put it?

[1] https://github.com/helge000/wimaging-ng/blob/master/README.md

Actions #1

Updated by Dominic Cleal over 8 years ago

  • Project changed from Foreman to Website
  • Category deleted (Facts)
Actions #2

Updated by Dominic Cleal over 8 years ago

Definitely, that would be great.

Under http://theforeman.org/manuals/1.10/index.html#4.4.8OSSpecificNotes would be best I think. We already have notes for FreeBSD and SLES, so adding a Windows section would make sense.

To add that, you'd edit manuals/1.10/index.md to add the section and then create _includes/manuals/1.10/4.4.8.3_prov_windows.md with the content. Note that 1.10 is the actively developed manual, but you could equally copy it back to 1.9 once done if you wished.

Actions #3

Updated by Daniel Helgenberger over 8 years ago

I think 1.10 is a good start..

I suppose screenshots go there?

static/images/screenshots

Are there any style guides you want me to consider?
Is there a maximum number of sub heading levels?

Actions #4

Updated by Dominic Cleal over 8 years ago

Yes, that looks right.

We don't have any style guide unfortunately, and the manual is written by a number of people with varying English skills. I'd just suggest sticking to a third person style.

Only about four levels of subheadings are numbered automatically. You'll find beyond five that the levels are difficult to tell apart, so avoid having the reader distinguish between say a level five or level six heading.

Actions #5

Updated by Daniel Helgenberger over 8 years ago

In the doc, I do reference my own project witch is needed to create installation media.

Basically there are two parts. I'd suggest:

- Leave out the part on how to create the media (and reference to the external project to create them?) thus only describing on how to get the foreman part working with the WAIK templates (I'll try to get them in community templates ;)

- Or, keep the whole part?
I like the fist better, since this offers a clear break and the docs would get quite large.

What do you think?

Actions #6

Updated by Daniel Helgenberger over 8 years ago

For the record: Opened PR209 on commuity-templates

[1] https://github.com/theforeman/community-templates/pull/209

Actions #7

Updated by Dominic Cleal over 8 years ago

I don't know the details, but yes, I'd generally agree the docs shouldn't go into a lot of detail about how to create the images. Ideally you could reference external docs from your project if that's possible, or consider putting it on the wiki if it's not up to the same standard as the main docs.

Actions #8

Updated by Dominic Cleal over 8 years ago

  • Status changed from New to Closed
  • % Done changed from 0 to 100
  • Pull request https://github.com/theforeman/theforeman.org/pull/450 added
Actions

Also available in: Atom PDF