This PR introduces much needed docs and sorts out #26.
Finally, we've got a software architecture document, a structured hands-on tute, and, wait for it, a decent repo readme! While we should put flesh on the bones of some sections and probably write an admin manual, the most critical content is there so if a hapless internaut bumps into Mr Boost the Adapter, they should be able to
dive into the architecture to understand what's going on under the bonnet and have a compass to navigate the stormy waters of the Go codebase and through the Istio maze
get a sense of what the system can do as well as how to deploy and operate the mesh---see demo
@gboege if you could please read through the content, hope it'll make sense to you too. Like I said ideally we'd have an admin manual too but the software architecture document and the hands-on tute already cover most of what admins need to know, except for the minute details of adapter config which you can find here:
Also, I've got a faint recollection of @jason-fox mentioning we should keep the content formal and stick to the Chicago manual of style. I've written the readme and software arch doc in a formal, academic style but have used standard SA spelling. It shouldn't be a train smash to change the spelling and possibly massage some of the content according to the Chicago recommendations. The tute is a different story though, totally informal and I religiously followed the venerable Goodwood manual of style. Please don't hate me, I'll rewrite it when I get a chance.
This PR introduces much needed docs and sorts out #26.
Finally, we've got a software architecture document, a structured hands-on tute, and, wait for it, a decent repo readme! While we should put flesh on the bones of some sections and probably write an admin manual, the most critical content is there so if a hapless internaut bumps into Mr Boost the Adapter, they should be able to
@gboege if you could please read through the content, hope it'll make sense to you too. Like I said ideally we'd have an admin manual too but the software architecture document and the hands-on tute already cover most of what admins need to know, except for the minute details of adapter config which you can find here:
Also, I've got a faint recollection of @jason-fox mentioning we should keep the content formal and stick to the Chicago manual of style. I've written the readme and software arch doc in a formal, academic style but have used standard SA spelling. It shouldn't be a train smash to change the spelling and possibly massage some of the content according to the Chicago recommendations. The tute is a different story though, totally informal and I religiously followed the venerable Goodwood manual of style. Please don't hate me, I'll rewrite it when I get a chance.