VCL Documentation

[Paul Thomas <pa...@ncsu.edu>]

Hello,

I'm a technical writing intern at NC State University on our VCL Team and I
would like to help with documentation for VCL.

Thank you!

Paul Thomas
-- 
*Paul A. Thomas*
OIT Project Management Lite Intern
Business Administration: IT
North Carolina State University '20
828.499.4034 | pathoma4@ncs.edu

Re: VCL Documentation

[Josh Thompson <jo...@ncsu.edu>]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Hi Paul,

Thanks for the email.

We had a discussion on the list a little while ago about moving our 
documentation to be written in markdown in a branch of our git repository 
named "documentation".  That branch is automatically compiled into HTML and 
CSS by a Jekyll job run by an Apache Jenkins server.  The results get pushed 
to the "asf-site-test" branch of the git repository.  You can fork the project 
on GitHub, make changes on the "documentation" branch and then submit pull 
requests against the VCL GitHub repo.  We can then pull those in to the ASF 
maintained git repo.

The desire for our documentation is to migrate everything from the Confluence 
site and vcl.apache.org to the documentation branch.  We also have a VCLDOCS 
Confluence site where we had started reworking the documentation, but that 
effort lost momentum.  I see you created an account on the Apache Confluence 
site.  I granted that account access to see the content at VCLDOCS.  (Anyone 
else reading this can request access, we just didn't want to open it up to the 
world until it was finished to help prevent confusing people with 
documentation in too many places.)

Our site really needs an overhaul in how the documentation is organized.  Any 
suggestions you have in how the information could be organized would be 
welcomed.

Thanks,
Josh

On Tuesday, October 16, 2018 4:25:06 PM EDT Paul Thomas wrote:
> Hello,
> 
> I'm a technical writing intern at NC State University on our VCL Team and I
> would like to help with documentation for VCL.
> 
> Thank you!
> 
> Paul Thomas

- -- 
- -------------------------------
Josh Thompson
VCL Developer
North Carolina State University

my GPG/PGP key can be found at pgp.mit.edu

All electronic mail messages in connection with State business which
are sent to or received by this account are subject to the NC Public
Records Law and may be disclosed to third parties.
-----BEGIN PGP SIGNATURE-----

iF0EARECAB0WIQRMIdRtWXideTZDK31X8tBw1209AwUCW8dQSgAKCRBX8tBw1209
A1evAJ0Q4qAgeSj4cqpmr4ulvPNOX5GHMQCePOVHaCz9QqYKknWP3hS6TzkUW7I=
=zoxp
-----END PGP SIGNATURE-----