Page 1 of 4 123 ... LastLast
Results 1 to 10 of 32

Thread: Documentation

  1. #1
    Who?
    Join Date
    Sep 2009
    Location
    Stockholm, Sweden
    Posts
    2,799

    Documentation

    Okay, I went crazy and redid the documentation repository. Now documentation is written in mark down and it's crazy simple to add to.

    You can preview the static output of a build at http://phogue.net/projects/docs/index.html


    You can contribute at https://github.com/Myrcon/Procon-2-Documentation

    It's not as big as you think. It's really-really easy to contribute. You can edit files in https://github.com/Myrcon/Procon-2-D...er/src/content

    If you want to add new sections I suggest you clone and go through the build process detailed in the main readme https://github.com/Myrcon/Procon-2-D...ster/README.md

    The markdown is displayed by github, so you can get a sorta-preview inline. You can see a markdown cheat sheet at https://github.com/adam-p/markdown-h...own-Cheatsheet

    I'll add a FAQ section tomorrow with questions and answers to be catalogued.
    I started at DICE late Oct. 2014, so ignore every post before that.

  2. #2
    Who?
    Join Date
    Sep 2009
    Location
    Stockholm, Sweden
    Posts
    2,799
    I added the start of a style guide at http://phogue.net/projects/docs/docu...yle-guide.html

    I added a very broad overview/introduction at http://phogue.net/projects/docs/gett...-it-works.html

    I'll be uploading changes at random intervals until the 20'th. I'll get a micro instance to host the docs and see about getting some of that CI behind it, so all changes in the repo are live on http://docs.myrcon.com
    I started at DICE late Oct. 2014, so ignore every post before that.

  3. #3
    Who?
    Join Date
    Sep 2009
    Location
    Stockholm, Sweden
    Posts
    2,799
    I've added basic security information. I'll be expanding on this over the week with more examples and details http://phogue.net/projects/docs/features-security.html
    I started at DICE late Oct. 2014, so ignore every post before that.

  4. #4
    Who?
    Join Date
    Sep 2009
    Location
    Stockholm, Sweden
    Posts
    2,799
    I've added to the list of infrastructure to setup on the 19'th/20'th: Free tier EC2 to host the compiled documentation.

    We'll have it located at http://docs.myrcon.com and it will deploy on every push. So every pull request we accept should be live on docs.myrcon.com within minutes.When I find time to do some documentation.

    I will be focusing on the developer areas. It probably won't be as detailed as you'll like, but instead reference the example plugins in the source and discuss what they are doing. Diagrams and what not as well.

    The goal would be a brief overview and an example or reference to an example for everything within Procon. I don't usually read docs, I just skip to the code.
    I started at DICE late Oct. 2014, so ignore every post before that.

  5. #5
    Who?
    Join Date
    Sep 2009
    Location
    Stockholm, Sweden
    Posts
    2,799
    Started the exceedingly long journey to documenting everything at http://phogue.net/projects/docs/deve...hitecture.html

    It's helpful doing it now though. I've already spotted some properties that can be better named to avoid confusion later on.

    Also made a dumping place for questions/answers we can expand on later at http://phogue.net/projects/docs/gett...arted-faq.html
    I started at DICE late Oct. 2014, so ignore every post before that.

  6. #6
    Quote Originally Posted by Phogue View Post
    Started the exceedingly long journey to documenting everything at http://phogue.net/projects/docs/deve...hitecture.html
    Security section is LMAO funny. Where'd you get those photos?

    "How it works" is a good first step. Needs more meat, obviously, but the diagram is helpful. Maybe label the lines with HTTP or REST or something like that where appropriate, then add RCON to/from game servers?

    I found the "UI" vs "Instance" terminology a bit confusing. I mean, there will be instances of the UI web server also, right? Unless you don't plan to do load-balancing. Plus, if I do a custom front-end that doesn't have a UI, maybe it's just an adapter to an existing automation service, calling it "UI" is misleading. A more typical terminology would be "front-end" vs. "back-end", or "web application" vs. "workers". If you insist on keeping "Instance", at least qualify it as a ".Net Instance".

    Architecture refers to a lot of concepts before they are defined or even mentioned elsewhere. That said, I'm starting to get an understanding just from what's there, so moar, moar.
    Don't send me private messages (PMs) unless you really need privacy, like your game server password. If you just have a question or need help, post in one of the threads. It's extra work for me to answer questions and give help in private messages and no one else gets the benefit of the answer.

  7. #7
    Administrator
    Join Date
    Mar 2010
    Location
    Tasmania, Australia
    Posts
    3,487
    I still think "Procon Gateway", or just "Gateway" for the C# Instance. "Web Panel" for the UI.

  8. #8
    The one and only Bassyboy
    Join Date
    Jul 2010
    Location
    Netherlands
    Posts
    3,274
    Procon Web UI vs Procon Daemon.

    Sent from my Nexus 7 using Tapatalk
    I won't do support via PM: if you need help, make a topic on the public forums.

  9. #9
    Who?
    Join Date
    Sep 2009
    Location
    Stockholm, Sweden
    Posts
    2,799
    Quote Originally Posted by PapaCharlie9 View Post
    Security section is LMAO funny. Where'd you get those photos?
    Stock photos. I did intend on buying very distinct stock photos so they could be identified easily, but I found the one model with three cliche poses and had to get them. I've also got him being an architect and in a bath robe on the beach. I do have the intent of using them in a lot more places for more examples.

    Quote Originally Posted by PapaCharlie9 View Post
    If you insist on keeping "Instance", at least qualify it as a ".Net Instance".
    I'm not set on any name. It has to be a mix of practical and marketing: "It connects to your X", "Get your Procon X hosted here!"

    I'd rule out the ".net instance" because it does not sound good in marketing, as well as the "Backend". We also have the backend of the frontend talking to the backend.

    Otherwise, keep brain storming. Matt is pushing Gateway.. so the bar is pretty low.
    I started at DICE late Oct. 2014, so ignore every post before that.

  10. #10
    Who?
    Join Date
    Sep 2009
    Location
    Stockholm, Sweden
    Posts
    2,799
    I should also note that I named "Layer" just to see if I could get people to call it that. Another rcon tool now has "Layer" support. It's great.

    I also codenamed this entire project: "Project Buttplug".

    The story here is that I should not come up with the name.

    I did name it "Haisan Instance" at one point. I think I named it "Archex" at one point early on, I don't know why. I think it was when I was brainstorming code names while being lazy one day until some one market-y thought of a name.

    If you've got any name you like, throw it in the mix.
    I started at DICE late Oct. 2014, so ignore every post before that.

 

 

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •