Search Unity

  1. Megacity Metro Demo now available. Download now.
    Dismiss Notice
  2. Unity support for visionOS is now available. Learn more in our blog post.
    Dismiss Notice

Offline documentation.

Discussion in 'General Discussion' started by Deleted User, Feb 2, 2021.

Thread Status:
Not open for further replies.
  1. Deleted User

    Deleted User

    Guest

    It was.

    Deleted
     
    Last edited by a moderator: Nov 30, 2021
    Noisecrime, NotaNaN, Vryken and 5 others like this.
  2. Ryiah

    Ryiah

    Joined:
    Oct 11, 2012
    Posts:
    20,952
    Dear Unity,

    Hire this person.
     
  3. MadeFromPolygons

    MadeFromPolygons

    Joined:
    Oct 5, 2013
    Posts:
    3,967
    Seconded! This is one of the best first posts on the forum!
     
    Joe-Censored likes this.
  4. Deleted User

    Deleted User

    Guest

    Thanks guys. I'm glad you like it.

    Sorry for delay.
    i realized that i failed my English exam. Reading is one thing, writing ...

    You put me in awkward situation by marking the thread as job seeking, i'm not professional.
     
    Last edited by a moderator: Feb 5, 2021
  5. Ryiah

    Ryiah

    Joined:
    Oct 11, 2012
    Posts:
    20,952
    We're saying your work is good enough that we would want to hire you not that you're trying to find a job with this thread. You may not see yourself as a professional but that's a very professional grade UI you've created for the offline documentation. I would love to see that be part of the online documentation too.
     
    Last edited: Feb 4, 2021
  6. Deleted User

    Deleted User

    Guest

    Never mind.
     
    Last edited by a moderator: Feb 5, 2021
  7. MadeFromPolygons

    MadeFromPolygons

    Joined:
    Oct 5, 2013
    Posts:
    3,967
    Im not sure you got what they meant, it was a good thing :)
     
  8. Deleted User

    Deleted User

    Guest

    I forgot to delete last sentence in quotes. 'never mind' in Oxford dictionary - 'used to tell sb not worry or be upset'.
     
  9. Deleted User

    Deleted User

    Guest

    I'm more worry about security. Does the forum a safe place to keep archives. Hashes will only add delusion of safety.
     
  10. Antypodish

    Antypodish

    Joined:
    Apr 29, 2014
    Posts:
    10,754
    That should be least of you worries. Why you even concerned about security? Like injecting a virus? You don't have exe files there anyway?

    Using rar (why?) would be bigger concern to me :)

    Mor serious is the fact, that forum may fail somehow, or be moved and your post and attachments may be gone.

    But if anything, you can use any file provider and store you work there.
    Or even better, put it on github. Anyone could see, what did changed. And even actively contribute.
    Problem solved.
     
  11. Deleted User

    Deleted User

    Guest

    The archives don't contain exe files, but can be infected with javascript, witch browser can execute, may be added links to some bad cites.

    The forum upload limit is 4Mb. ScriptReference: not compressed ~ 55MB, rar ~ 3.8MB, zip ~ 12.6MB.
    The whole doc without 'uploads' folder zip ~ 31MB.

    The program can solve security problems, because it process documentation on the user machine from user source, but currently is not in good shape to be place on github.
    I don't know how match efforts it require to make it run on any platform, dealt with user source etc. Not to mention it may be useless soon.

    It can process Unity documentations back to ~ 5.3 version with some code correction.
    What you see is the result, not a work.
     
    Last edited by a moderator: Feb 8, 2021
  12. Antypodish

    Antypodish

    Joined:
    Apr 29, 2014
    Posts:
    10,754
    In my opinion this is really good reason to put it there.
    People will try to fix things, if gets broken or maybe incomplete otherwise.
    That providing your work gets enough traction.
    Assuming you not trying to sell your work, but just share it.

    Otherwise, you stuck with work alone and whatever bug fixes it may have.
    If you not selling, (I suspect you can not) just put it on git, and let it magic happen from contributors. :)

    There is no point to holding it of for yourself, if is just free to use as your main goal.

    And you won't need to bother with that whole compression issue.
     
  13. Ryiah

    Ryiah

    Joined:
    Oct 11, 2012
    Posts:
    20,952
    Unity's game engine install is 1 GB. A 55 MB download is nothing by comparison. Use zip. Every platform natively supports it. The same can't be said about rar (or 7z which is the format I would choose over zip if I wanted better compression).
     
    Antypodish and MadeFromPolygons like this.
  14. Deleted User

    Deleted User

    Guest

    Split this doc into 5 zip parts is not good idea.
    Put it somewhere else as single zip - i'm not the owner of the documentation content.

    Thanks for hint. 7z has even better compression than rar. I had updated 7-Zip recently but not try it.
     
    Last edited by a moderator: Feb 8, 2021
  15. angrypenguin

    angrypenguin

    Joined:
    Dec 29, 2011
    Posts:
    15,614
    Another option is to host it somewhere such as Google Drive, DropBox or OneDrive and share a public link to it.
     
    MadeFromPolygons likes this.
  16. Deleted User

    Deleted User

    Guest

    Deleted
     
    Last edited by a moderator: Nov 28, 2021
  17. Deleted User

    Deleted User

    Guest

    Deleted
     
    Last edited by a moderator: Nov 28, 2021
  18. Deleted User

    Deleted User

    Guest

    Deleted
     
    Last edited by a moderator: Nov 28, 2021
  19. Deleted User

    Deleted User

    Guest

    Deleted
     
    Last edited by a moderator: Nov 28, 2021
  20. Deleted User

    Deleted User

    Guest

    Deleted
     
    Last edited by a moderator: Nov 28, 2021
    MadeFromPolygons likes this.
  21. MadeFromPolygons

    MadeFromPolygons

    Joined:
    Oct 5, 2013
    Posts:
    3,967
    I highly recommend hosting it via dropbox or google drive, most wont use downloads from the forum
     
    Antypodish likes this.
  22. Deleted User

    Deleted User

    Guest

    I wish that i could ...:D
     
  23. Antypodish

    Antypodish

    Joined:
    Apr 29, 2014
    Posts:
    10,754
    Why? What stops you from doing that?
     
    MadeFromPolygons likes this.
  24. Ryiah

    Ryiah

    Joined:
    Oct 11, 2012
    Posts:
    20,952
    Both of those services are completely free...
     
    MadeFromPolygons and Antypodish like this.
  25. Deleted User

    Deleted User

    Guest

    Do you hear something about copyright?:D
    I doubt this thread will last long.
     
  26. Antypodish

    Antypodish

    Joined:
    Apr 29, 2014
    Posts:
    10,754
    Then write as Wiki :D
     
    NotaNaN and MadeFromPolygons like this.
  27. MadeFromPolygons

    MadeFromPolygons

    Joined:
    Oct 5, 2013
    Posts:
    3,967
    Yeah exactly, sort of baffled why you would spend time making this only to let it die in a forum thread instead of distributing it properly....
     
    NotaNaN and Antypodish like this.
  28. Well, you have the option to head to the Documentation forum and try to connect with the Documentation team and ask for blessing.
     
    NotaNaN and Antypodish like this.
  29. Ryiah

    Ryiah

    Joined:
    Oct 11, 2012
    Posts:
    20,952
    On the contrary I would be surprised if they took it down. Based on this and your initial response to our praise you seem to have this bizarre thought that the admins and mods will put a stop to activity like this but I see nothing in this thread that would warrant them doing it.
     
    Last edited: Mar 2, 2021
    NotaNaN and Antypodish like this.
  30. Deleted User

    Deleted User

    Guest

    Why? Compression format, security concerns, too many movement involve?

    Every documentation page at the bottom contains 'Copyright ? Unity Technologies' not 'Copyright ? Documentation team'.
    How could Doc team bless me?

    Thought about the consequences of breaking the copyright isn't bizarre one.
     
  31. Copyright isn't that rigid. They can allow you to make and distribute this type of reskin/optimized version of their work given that you do not distribute it under your own name and for free of charge. They also can choose to work with you in some shape or form. Obviously they only can choose either shut you down or choose to work with you if they know about you and your project. And since they usually don't come to the General Discussion forum...
     
  32. Antypodish

    Antypodish

    Joined:
    Apr 29, 2014
    Posts:
    10,754
    Simply as mentioned earlier, it will get lost, in pail of other threads. Burried and forgotten.
    Also, this isnt right way to put documents up.

    Common man, if you so much concernd about copy rights, why you even started this thread?
    Not to mention even starting on such work and publicising, without asking for permissioj prior.
    As suggested, go speak to a team, ask for a permission. See what they will reply to you. At least you will know, what you are standing on. Simple as that.
     
    MadeFromPolygons likes this.
  33. Deleted User

    Deleted User

    Guest

    How to close this thread?
     
  34. neginfinity

    neginfinity

    Joined:
    Jan 27, 2013
    Posts:
    13,554
    You'd need to ping a moderator to do that. Like @hippocoder.

    Is there a reason to close it, though?
     
    Antypodish and MadeFromPolygons like this.
  35. Ryiah

    Ryiah

    Joined:
    Oct 11, 2012
    Posts:
    20,952
    On the contrary for a situation like this it is bizarre to be worried about it.
     
    Antypodish and MadeFromPolygons like this.
  36. Deleted User

    Deleted User

    Guest

    It's quite time consuming. Number of downloads is very small. Also it's difficult to automate updates - the program is vulnerable to the documentation changes.
     
  37. Antypodish

    Antypodish

    Joined:
    Apr 29, 2014
    Posts:
    10,754
    [Quay OTE="Hallucinogen, post: 7218271, member: 1587442"]It's quite time consuming. Number of downloads is very small. Also it's difficult to automate updates - the program is vulnerable to the documentation changes.[/QUOTE]

    Of course it has low download rate. Few days after our last post in march, was already on the bottom if not second page of general forum. Which what we told you few times, that it will happen. If you had wiki or git, you would had chance to be open for contributors.

    You wanted feedback and share your work. We want to help and clarify any doubts. But in the end, you just ignored any o our advice.
    So what to expect?

    You ma do super good work, but if you forcing yourself against the wind, you most likely going to stuck. Instead, you should be open for collaboration. But you won't be discovered on the forum like that.

    So it is maybe a time, to reconsider and upload to wiki or git?
    What worse can happen?
    Get notification from Unity?
    Like no one is going to sue you, or something like that.
     
  38. Deleted User

    Deleted User

    Guest

    Deleted
     
    Last edited by a moderator: Nov 28, 2021
  39. MadeFromPolygons

    MadeFromPolygons

    Joined:
    Oct 5, 2013
    Posts:
    3,967
    I dont think that many people are going to continue to check this thread. Having a thread is not the way to go about releasing this. You need some sort of hosting. (like every user has asked for since you first posted)

    This is great, but I expect this to get lost in the many threads on the forums soon as a result...
     
    Antypodish likes this.
  40. Deleted User

    Deleted User

    Guest

    It won't work no matter were it's hosted. Numbers of developers who use offline documentation probably very small. Most likely they have some problems accessing the Internet and do not search the Dropbox, the Google Drive, the Github etc. for offline doc. They use Hub or download it from official urls.

    Placing project on Github, if take into account how much interest this raises, it's the sea of troubles - multiple platforms, 18 versions, ~270 builds if count from version 5.6, which program may encounter on user's disks and must process to the last dot.
    The Asset store don't respect executable, as an Editor plugin - probably even more troubles than the Github.

    So the future of this is obvious.
     
    Last edited by a moderator: Jul 21, 2021
  41. april_4_short

    april_4_short

    Joined:
    Jul 19, 2021
    Posts:
    489
    @Hallucinogen

    Great name!

    GREATER WORKS!!!

    What you have done, it is... AMAZING!!!

    Well done.

    Personally, I would happily subscribe to an email of updates. What you have made is incredible for working fast and light.

    Cannot thank you enough.

    What is your native language?
     
  42. Ryiah

    Ryiah

    Joined:
    Oct 11, 2012
    Posts:
    20,952
    No. I expect it to be far higher for multiple reasons. One of which is the console documentation on the side of Unity is entirely offline due to NDAs. Second is we're constantly being asked for ways to download the engine and its documentation for offline installs because not everyone has the Internet at home.
     
  43. april_4_short

    april_4_short

    Joined:
    Jul 19, 2021
    Posts:
    489
    Also...it's WAY faster. This, alone, is a compounding benefit of offline docs.

    Dash for Mac is a must use... just for the speed. And the search. And the bookmarking.

    https://kapeli.com/dash
     
    Ryiah likes this.
  44. Antypodish

    Antypodish

    Joined:
    Apr 29, 2014
    Posts:
    10,754
    This is imaginary problem.
    Have you heard about branches?
     
  45. Deleted User

    Deleted User

    Guest

    It's base on my experience with Unity documentation, probably those who develop it don't use it for themselves.:p

    Personal time is real.
     
    april_4_short likes this.
  46. april_4_short

    april_4_short

    Joined:
    Jul 19, 2021
    Posts:
    489
    And I suspect the folks that make the engine don't write the docs.

    for fun, I'd add something about separation of church and state... but this is a humourless place.
     
    stain2319 likes this.
  47. Antypodish

    Antypodish

    Joined:
    Apr 29, 2014
    Posts:
    10,754
    That where is the point of contributors.
     
    Ryiah and MadeFromPolygons like this.
  48. Deleted User

    Deleted User

    Guest

    The experimental feature change it status, so i update all Manuals and gif.
     
  49. Deleted User

    Deleted User

    Guest

    I updated all docs to the latest changes.

    Just an interesting fact, all above docs can perfectly work with online resources, i.e. there is no need to have those 'uploads' and 'ScriptRefImages' folders on your disks. Of course, in order to work this requires Internet connection.
    To enable this, you need to edit 'StaticFilesManual/js/core.js' and 'StaticFiles/js/core.js' files. At the beginning, set to true 'enableOnlineResources' variable.
    See demo version above.
     
  50. Deleted User

    Deleted User

    Guest

    The usual update pipeline:
    1. upload to the forum
    2. discover vital or unpleasant bug
    3. fix it
    4. go to line 1
     
Thread Status:
Not open for further replies.