Pages: [1] 2 :: one page |
|
Author |
Thread Statistics | Show CCP posts - 13 post(s) |
|
CCP FoxFour
C C P C C P Alliance
3245
|
Posted - 2014.05.24 11:18:00 -
[1] - Quote
Hey guys,
Documentation. It's a really fun thing isn't it? A few days ago while discussing documentation for the EVE SSO (which even though the SSO trial will be limited documentation will be public) we knew we wanted it to be public. The problem was where to put it. The EVElopedia section for third party devs wasn't just lacking information, it had a lot of wrong information. Which is even worse.
The decision was made to nuke the existing pages and start from scratch. This gives us the opportunity to not just fix the documentation but organize it in a better way.
This effort is under way now and you can see the basics of it here: https://wiki.eveonline.com/en/wiki/Third_Party_Developers
This is something that will go a lot better and quicker with help from you guys, but at the very least I want you all to know whats going on.
Our goal is to organize information in a more structured way than before. We will see how this goes... maybe it is a horrible plan and all things will fail terribly but hey should be an interesting experience none the less. CCP FoxFour // Game Designer // @regnerba
|
|
Salpun
Global Telstar Federation Offices Masters of Flying Objects
745
|
Posted - 2014.05.24 11:20:00 -
[2] - Quote
Template work. Is the top fine or do you want a right justified window if so ill grab the coding from some where else. If i dont know something about EVE. I check https://wiki.eveonline.com/en/wiki/ISK_The_Guide
See you around the universe. |
Salpun
Global Telstar Federation Offices Masters of Flying Objects
745
|
Posted - 2014.05.24 11:40:00 -
[3] - Quote
Right justified at the top would maybe work better. If i dont know something about EVE. I check https://wiki.eveonline.com/en/wiki/ISK_The_Guide
See you around the universe. |
|
CCP FoxFour
C C P C C P Alliance
3245
|
Posted - 2014.05.24 11:48:00 -
[4] - Quote
I was thinking that and really like it but was worried about how big it might become... :( CCP FoxFour // Game Designer // @regnerba
|
|
Salpun
Global Telstar Federation Offices Masters of Flying Objects
745
|
Posted - 2014.05.24 11:49:00 -
[5] - Quote
CCP FoxFour wrote:I was thinking that and really like it but was worried about how big it might become... :( how many more main pages are you thinking of adding
If i dont know something about EVE. I check https://wiki.eveonline.com/en/wiki/ISK_The_Guide
See you around the universe. |
|
CCP FoxFour
C C P C C P Alliance
3245
|
Posted - 2014.05.24 11:58:00 -
[6] - Quote
Added image server and DLA but also removed the library links. I don't think we have enough libraries for them to need their own page. CCP FoxFour // Game Designer // @regnerba
|
|
Salpun
Global Telstar Federation Offices Masters of Flying Objects
745
|
Posted - 2014.05.24 12:01:00 -
[7] - Quote
what category are we using for these pages besides Technical
What about the site advertizement pages that where nuked how do you want to address that wiki use case. If i dont know something about EVE. I check https://wiki.eveonline.com/en/wiki/ISK_The_Guide
See you around the universe. |
|
CCP FoxFour
C C P C C P Alliance
3245
|
Posted - 2014.05.24 12:11:00 -
[8] - Quote
Salpun wrote:what category are we using for these pages besides Technical
What about the site advertizement pages that where nuked how do you want to address that wiki use case.
Ad a dev supervised area set policy so those that work the Wiki users can conform to the norm you want.
Will we be getting a new static data import soon?
Not sure about either yet. Especially on the categories thing, not really a huge fan of categories myself. I much prefer more structured organization. Thats why I created the third party dev template.
As for the advertisement area I will look into that after getting this first stuff sorted out more clearly. Need to do more experimentation first before moving on. :) CCP FoxFour // Game Designer // @regnerba
|
|
Salpun
Global Telstar Federation Offices Masters of Flying Objects
745
|
Posted - 2014.05.24 12:16:00 -
[9] - Quote
CCP FoxFour wrote:Salpun wrote:what category are we using for these pages besides Technical
What about the site advertizement pages that where nuked how do you want to address that wiki use case.
Ad a dev supervised area set policy so those that work the Wiki users can conform to the norm you want.
Will we be getting a new static data import soon? Not sure about either yet. Especially on the categories thing, not really a huge fan of categories myself. I much prefer more structured organization. Thats why I created the third party dev template. As for the advertisement area I will look into that after getting this first stuff sorted out more clearly. Need to do more experimentation first before moving on. :) Main thing is focus on policy and facts. I or other wiki warriors can standardize the pages once you decide on the format. If i dont know something about EVE. I check https://wiki.eveonline.com/en/wiki/ISK_The_Guide
See you around the universe. |
Salpun
Global Telstar Federation Offices Masters of Flying Objects
745
|
Posted - 2014.05.24 12:49:00 -
[10] - Quote
Not seeing anything in the sidebar template page after the rewrite.
White lol that looks bad. If i dont know something about EVE. I check https://wiki.eveonline.com/en/wiki/ISK_The_Guide
See you around the universe. |
|
|
CCP FoxFour
C C P C C P Alliance
3245
|
Posted - 2014.05.24 13:44:00 -
[11] - Quote
Salpun wrote:Not seeing anything in the sidebar template page after the rewrite.
White lol that looks bad.
Yea I was playing around with some templates while thinking about how I wanted to organize stuff. I got a phone call and had to run though so it's a bit broken. >.<
I should hopefully be back tonight to continue some of this. CCP FoxFour // Game Designer // @regnerba
|
|
Salpun
Global Telstar Federation Offices Masters of Flying Objects
745
|
Posted - 2014.05.24 13:47:00 -
[12] - Quote
CCP FoxFour wrote:Salpun wrote:Not seeing anything in the sidebar template page after the rewrite.
White lol that looks bad. Yea I was playing around with some templates while thinking about how I wanted to organize stuff. I got a phone call and had to run though so it's a bit broken. >.< I should hopefully be back tonight to continue some of this. The if then statement list is so long it breaks the text limit I think. will test some do not show text statements to see if that is the case. Removed the white already. If i dont know something about EVE. I check https://wiki.eveonline.com/en/wiki/ISK_The_Guide
See you around the universe. |
Bienator II
madmen of the skies
2658
|
Posted - 2014.05.24 16:29:00 -
[13] - Quote
awesome! eve style bounties (done) dust boarding parties imagine there is war and everybody cloaks - join FW |
ItsmeHcK1
Kicked. Shadow Cartel
111
|
Posted - 2014.05.24 21:57:00 -
[14] - Quote
A good CCP-side documentation is long overdue. I'll throw some pages in as I go along. |
Equto
outerworld scrapmetal reprocessing
31
|
Posted - 2014.05.25 03:24:00 -
[15] - Quote
Quote:Have some documentation together internally, will copy and paste it here in a few days. ~CCP SocksFour
If this doesn't come true can I hold you to it ?
|
Dei
Khanid Brotherhood
31
|
Posted - 2014.05.25 14:56:00 -
[16] - Quote
Can I ask how this is generated (or rather how it will be generated)? I'm hoping that if you add a new field to an API call someone won't have to update the relevant page? Or if a type is changed, it'll automatically update the relevant pages?
I think a partially automatic wiki would be far better than a rewrite and a promise to keep it up to date. |
Salpun
Global Telstar Federation Offices Masters of Flying Objects
745
|
Posted - 2014.05.25 15:02:00 -
[17] - Quote
Dei wrote:Can I ask how this is generated (or rather how it will be generated)? I'm hoping that if you add a new field to an API call someone won't have to update the relevant page? Or if a type is changed, it'll automatically update the relevant pages?
I think a partially automatic wiki would be far better than a rewrite and a promise to keep it up to date. Unless they are going to update the structure of the wiki I don't think that is possible. Every update of Item database leaves dead links and no info on the page.
The same for the Dev pages they get locked down and only ISD can change them.
The good thing is that with crest and API under one person they can keep it or a forum thread updated and as long as the forum thread is correct all the information will be easily accessible. If i dont know something about EVE. I check https://wiki.eveonline.com/en/wiki/ISK_The_Guide
See you around the universe. |
|
CCP FoxFour
C C P C C P Alliance
3248
|
Posted - 2014.05.25 17:14:00 -
[18] - Quote
Dei wrote:Can I ask how this is generated (or rather how it will be generated)? I'm hoping that if you add a new field to an API call someone won't have to update the relevant page? Or if a type is changed, it'll automatically update the relevant pages?
I think a partially automatic wiki would be far better than a rewrite and a promise to keep it up to date.
This will all have to be done manually. It's **** but the EVE API is written in a funky way. For CREST as well things will have to be manual for now, we have a way to auto generate them but not really in a format for a Wiki. CCP FoxFour // Game Designer // @regnerba
|
|
Kale Freeman
Dirt 'n' Glitter I Whip My Slaves Back and Forth
23
|
Posted - 2014.05.26 08:05:00 -
[19] - Quote
Auto-generate it and make it available for download somewhere. Link to the download from a manually maintained wiki page.
I will deal with whatever format your auto generated documentation comes out in. Just keep it up-to-date, accurate and complete. I would guess that the people who are looking for the API documentation would value up-to-date, accurate and complete much higher than "on the wiki". I might be wrong.
|
|
CCP FoxFour
C C P C C P Alliance
3278
|
Posted - 2014.06.01 20:32:00 -
[20] - Quote
Continuing my efforts on the documentation. Got some getting started examples done for the EVE API and setup a page for SDE common queries.
Will continuing poking it over time. Thanks to everyone who has been helping so far. :D CCP FoxFour // Game Designer // @regnerba
|
|
|
Jad Ellirya
ICE is Coming to EVE Goonswarm Federation
1
|
Posted - 2014.06.06 08:19:00 -
[21] - Quote
Yeah ! Thank you for your work ! :D |
brammator
SUB ZERO. Legion of xXDEATHXx
98
|
Posted - 2014.08.03 21:36:00 -
[22] - Quote
What is limit on /eve/CharacterAffiliation.xml.aspx for ids? 100, 200, 10000? |
|
CCP FoxFour
C C P C C P Alliance
3389
|
Posted - 2014.08.03 22:14:00 -
[23] - Quote
brammator wrote:What is limit on /eve/CharacterAffiliation.xml.aspx for ids? 100, 200, 10000?
Should be the same as the rest, 250. :) CCP FoxFour // Game Designer // @regnerba
|
|
brammator
SUB ZERO. Legion of xXDEATHXx
98
|
Posted - 2014.08.04 05:10:00 -
[24] - Quote
means 8 request for Jita local >_> |
|
CCP FoxFour
C C P C C P Alliance
3389
|
Posted - 2014.08.04 09:48:00 -
[25] - Quote
brammator wrote:means 8 request for Jita local >_>
A lot better than the previous 1 request per character! :P CCP FoxFour // Game Designer // @regnerba
|
|
Wollari
Dirt Nap Squad Dirt Nap Squad.
76
|
Posted - 2014.08.18 21:35:00 -
[26] - Quote
(deleted wrong thread) DOTLAN EveMaps-á| Your out-of-game map, navigation toolset, sov database, etc. since 2008 |
Althalus Stenory
Flying Blacksmiths
33
|
Posted - 2014.08.29 12:25:00 -
[27] - Quote
My only thought is that the lack of official API/CREST doc atm is sad.
We need to search through google to find examples / "complete" docs for many things or even ask people on the forum for basic stuffs about API/SDE.
Yes, you will say neweden-dev has docs, but not everything is up to date: for example some CREST endpoint are missing, like http://public-crest.eveonline.com/industry/systems/. And i'll add, wiki.eve-id.net had most of the docs too, until it was abandoned and only "used" by spam bots.
The point is, no, i don't want to edit / add things on any external wiki where only 1-2 informations are missing, for one single reason : I don't know if the wiki will stay alive as long as EVE exists. Private wiki will never be up to date, because EVE constantly evolve, and because it requires time and people who do it, do it on their free time as long as they still play EVE.
And (sadly) I don't have time to spend to add all the data I know on the official eve wiki... :(
It takes a lot of time, I know that... but, I think user docs should be done at the same time the features / changes are done, not months after everything is released (because nobody usually wants to do it after...)
BTW, you do a great job FoxFour :D |
|
CCP FoxFour
C C P C C P Alliance
3484
|
Posted - 2014.08.29 13:32:00 -
[28] - Quote
Althalus Stenory wrote:My only thought is that the lack of official API/CREST doc atm is sad. We need to search through google to find examples / "complete" docs for many things or even ask people on the forum for basic stuffs about API/SDE. Yes, you will say neweden-dev has docs, but not everything is up to date: for example some CREST endpoint are missing, like http://public-crest.eveonline.com/industry/systems/.And i'll add, wiki.eve-id.net had most of the docs too, until it was abandoned and only "used" by spam bots. The point is, no, i don't want to edit / add things on any external wiki where only 1-2 informations are missing, for one single reason : I don't know if the wiki will stay alive as long as EVE exists. Private wiki will never be up to date, because EVE constantly evolve, and because it requires time and people who do it, do it on their free time as long as they still play EVE. And (sadly) I don't have time to spend to add all the data I know on the official eve wiki... :( It takes a lot of time, I know that... but, I think user docs should be done at the same time the features / changes are done, not months after everything is released (because nobody usually wants to do it after...) BTW, you do a great job FoxFour :D
See this post: https://forums.eveonline.com/default.aspx?g=posts&m=4956658#post4956658
Official documentation does exist, and better stuff is coming soon. CCP FoxFour // Game Designer // @RegnerBA |
|
Althalus Stenory
Flying Blacksmiths
33
|
Posted - 2014.08.29 14:06:00 -
[29] - Quote
Ow.. my apologies. So... If i understand, neweden-dev is the official API/CREST doc (and for CREST we have the root, as it's a RESTful API) ? :o (or I'm really stupid and I don't understand lol)
And i'm curious about the "better stuff" ^^
Thanks :) |
|
CCP FoxFour
C C P C C P Alliance
3484
|
Posted - 2014.08.29 14:09:00 -
[30] - Quote
Althalus Stenory wrote:Ow.. my apologies. So... If i understand, neweden-dev is the official API/CREST doc (and for CREST we have the root, as it's a RESTful API) ? :o (or I'm really stupid and I don't understand lol) And i'm curious about the "better stuff" ^^ Thanks :)
NewEden-Dev is NOT official. My point was you can get official documentation from the OPTIONS call. CCP FoxFour // Game Designer // @RegnerBA |
|
|
|
|
|
Pages: [1] 2 :: one page |
First page | Previous page | Next page | Last page |