public inbox for linux-xfs@vger.kernel.org
 help / color / mirror / Atom feed
* [ANNOUNCE] updated xfs documentation available
@ 2010-08-23 16:22 Eric Sandeen
  2010-08-23 22:03 ` Kinzel, David
  0 siblings, 1 reply; 3+ messages in thread
From: Eric Sandeen @ 2010-08-23 16:22 UTC (permalink / raw)
  To: xfs-oss

Just as an FYI, we've converted some of the older SGI XFS documentation
to XML/Docbook/Publican[1] format, and it's now available on xfs.org; see
http://xfs.org/index.php/XFS_Papers_and_Documentation

particularly the 3 links at the top, 

    * XFS User Guide 

    * XFS File System Structure 

    * XFS Training Labs 

In addition to the XML conversion, much of the documentation has
been updated & corrected compared to the original docs.

This should be good material for anyone using, developing, or supporting
XFS.  If omissions or errors are found, we'd be happy to accept
patches against the XML source for the docs, found at
http://git.kernel.org/?p=fs/xfs/xfsdocs-xml-dev.git;a=summary

In addition, using that git repo + publican allows one to create
the documentation in various other forms such as PDFs, txt,
and epub.

Thanks!

-Eric

[1] https://fedorahosted.org/publican/

_______________________________________________
xfs mailing list
xfs@oss.sgi.com
http://oss.sgi.com/mailman/listinfo/xfs

^ permalink raw reply	[flat|nested] 3+ messages in thread

* RE: [ANNOUNCE] updated xfs documentation available
  2010-08-23 16:22 [ANNOUNCE] updated xfs documentation available Eric Sandeen
@ 2010-08-23 22:03 ` Kinzel, David
  2010-08-23 22:05   ` Eric Sandeen
  0 siblings, 1 reply; 3+ messages in thread
From: Kinzel, David @ 2010-08-23 22:03 UTC (permalink / raw)
  To: Eric Sandeen, xfs-oss

>Just as an FYI, we've converted some of the older SGI XFS documentation
>to XML/Docbook/Publican[1] format, and it's now available on 
>xfs.org; see
>http://xfs.org/index.php/XFS_Papers_and_Documentation
>
>particularly the 3 links at the top, 
>
>    * XFS User Guide 
>
>    * XFS File System Structure 
>

I am not sure about the other guides, but the images in the html output
are being sized down making them not-so-readable. Eg,
http://xfs.org/docs/xfsdocs-xml-dev/XFS_Filesystem_Structure//tmp/en-US/
html/Internal_Inodes.html

Would it be possible to regenerate these with the scaling off?

Thanks,

>    * XFS Training Labs 
>
>In addition to the XML conversion, much of the documentation has
>been updated & corrected compared to the original docs.
>
>This should be good material for anyone using, developing, or 
>supporting
>XFS.  If omissions or errors are found, we'd be happy to accept
>patches against the XML source for the docs, found at
>http://git.kernel.org/?p=fs/xfs/xfsdocs-xml-dev.git;a=summary
>
>In addition, using that git repo + publican allows one to create
>the documentation in various other forms such as PDFs, txt,
>and epub.
>
>Thanks!
>
>-Eric
>
>[1] https://fedorahosted.org/publican/

This email communication and any files transmitted with it may contain confidential and or proprietary information and is provided for the use of the intended recipient only.  Any review, retransmission or dissemination of this information by anyone other than the intended recipient is prohibited.  If you receive this email in error, please contact the sender and delete this communication and any copies immediately.  Thank you.
http://www.encana.com



_______________________________________________
xfs mailing list
xfs@oss.sgi.com
http://oss.sgi.com/mailman/listinfo/xfs

^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [ANNOUNCE] updated xfs documentation available
  2010-08-23 22:03 ` Kinzel, David
@ 2010-08-23 22:05   ` Eric Sandeen
  0 siblings, 0 replies; 3+ messages in thread
From: Eric Sandeen @ 2010-08-23 22:05 UTC (permalink / raw)
  To: Kinzel, David; +Cc: xfs-oss

Kinzel, David wrote:
>> Just as an FYI, we've converted some of the older SGI XFS documentation
>> to XML/Docbook/Publican[1] format, and it's now available on 
>> xfs.org; see
>> http://xfs.org/index.php/XFS_Papers_and_Documentation
>>
>> particularly the 3 links at the top, 
>>
>>    * XFS User Guide 
>>
>>    * XFS File System Structure 
>>
> 
> I am not sure about the other guides, but the images in the html output
> are being sized down making them not-so-readable. Eg,
> http://xfs.org/docs/xfsdocs-xml-dev/XFS_Filesystem_Structure//tmp/en-US/
> html/Internal_Inodes.html
> 
> Would it be possible to regenerate these with the scaling off?
> 
> Thanks,

Interesting, I'll have to look into how publican decides to scale images
when it generates html... not sure offhand.  :)

Thanks,
-Eric

_______________________________________________
xfs mailing list
xfs@oss.sgi.com
http://oss.sgi.com/mailman/listinfo/xfs

^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2010-08-23 22:04 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2010-08-23 16:22 [ANNOUNCE] updated xfs documentation available Eric Sandeen
2010-08-23 22:03 ` Kinzel, David
2010-08-23 22:05   ` Eric Sandeen

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox