Pārlūkot izejas kodu

Pushed more for GitHub project hosting

Björn Ritzl 6 gadi atpakaļ
vecāks
revīzija
59206d1a4a

+ 1 - 3
docs/en/faq/faq.md

@@ -27,9 +27,7 @@ Can I trust Defold for professional development?
 
 Why do I have to store my games on Defold's servers?
 
-: You don't have to. Starting with Defold editor 2 you can store your games wherever you want. Defold was originally designed to be a complete turnkey service, including collaboration tools and storage. There are benefits to using our servers and we will continue to supply value to those who do use it through the dashboard. However, we realize that some users prefer other storage providers and we are working on supporting that.
-
-  If you are tech-savvy, there is a workaround available. See [this HOWTO on our forum](//forum.defold.com/t/howto-alternative-project-hosting/1309).
+: You don't have to. Starting with Defold editor 2 you can open projects from any location on your hard drive and they can be either completely local, imported from the Defold dashboard or cloned from any version control system to your harddrive.
 
 What kind of user tracking are you doing?
 

+ 10 - 6
docs/en/manuals/libraries.md

@@ -15,26 +15,30 @@ Libraries are useful for the following purposes:
 
 ## Setting up library sharing
 
-Suppose you want to build a library containing shared sprites and tile sources. You start by setting up a new project in the Defold dashboard (see the [Workflow documentation](/manuals/workflow) for details). Decide what folders you want to share from the project and add the names of those folders to the *include_dirs* property in the Project settings. If you want to list more than one folder, separate the names with spaces:
+Suppose you want to build a library containing shared sprites and tile sources. You start by [setting up a new project](/manuals/project-setup/). Decide what folders you want to share from the project and add the names of those folders to the *include_dirs* property in the Project settings. If you want to list more than one folder, separate the names with spaces:
 
 ![Include dirs](images/libraries/libraries_include_dirs.png)
 
-The Defold server needs to know that the project contain folders that should be shared. Therefore, make sure to _Synchronize your project_. Now, before we can add this library to another project we need to a way to locate the library.
+Before we can add this library to another project we need to a way to locate the library.
 
 ## Library URL
 
-Libraries are referred to via a standard URL. For a project hosted on the Defold servers it would be the Library URL that can be found in the Dashboard. Just select the relevant project and write down or copy the URL:
+Libraries are referred to via a standard URL. For a project hosted on GitHub it would be the URL to a project release:
 
-![Library URL](images/libraries/libraries_library_url.png)
+![GitHub Library URL](images/libraries/libraries_library_url_github.png)
 
-For a project hosted on GitHub it would be the URL to a project release:
+For a project hosted on the Defold servers it would be the Library URL that can be found in the Dashboard. Just select the relevant project and write down or copy the URL:
 
-![GitHub Library URL](images/libraries/libraries_library_url_github.png)
+![Library URL](images/libraries/libraries_library_url.png)
 
 ::: important
 It is recommend to always depends on a specific release of a library project instead of on the master branch. This way it is up to you as a developer to decide when to incorporate changes from a library project as opposed to always getting the latest (and potentially breaking) changes from the master branch of a library project.
 :::
 
+::: important
+Note that you need read access to the Library URL. For GitHub projects, that means that the project has to be either public or that you have generated an access token. For Defold hosted projects, that means you need to be a member of the dependent projects.
+:::
+
 ## Setting up library dependencies
 
 Open the project that you would like to access the library from. In the project settings, add the Library URL to the *dependencies* property. You can specify multiple dependent projects if you want. Just add them one by one using the `+` button and remove using the `-` button:

+ 1 - 1
docs/en/manuals/project-settings.md

@@ -32,7 +32,7 @@ Compress Archive
 : Enables compression of archives when bundling. Note that this currently applies to all platforms except Android where the apk already contains all data compressed.
 
 Dependencies
-: A list of URLs to the project *Library URL*s. For Defold hosted projects, the URL is found on the project page on the [Dashboard](//www.defold.com/dashboard/)). Note that you need read access to the URL. For Defold hosted projects, that means you need to be a member of the dependent projects.
+: A list of URLs to the project *Library URL*s. Refer to the [Libraries manual](/manuals/libraries/) for more information. 
 
 Custom Resources
 : A comma separated list of resources that will be included in the project. If directories are specified, all files and directories in that directory are recursively included. The resources can be loaded using [`sys.load_resource()`](/ref/sys/#sys.load_resource).

+ 11 - 1
docs/en/manuals/project-setup.md

@@ -7,12 +7,22 @@ brief: This manual covers how to create or open a project in Defold.
 
 You can easily create a new project from within the Defold editor. You also have the option to import an existing project from the Defold dashboard as well as open an existing project already located on your computer.
 
-## Creating a new project
+## Creating a new local project
 
 Click the <kbd>New Project</kbd> option and select what kind of project you would like to create. Specify a location on your hard drive where the project files will be stored. Click <kbd>Create New Project</kbd> to create the project in the location you've chosen.
 
 ![open project](images/workflow/open_project.png){srcset="images/workflow/[email protected] 2x"}
 
+### Adding the project to GitHub
+
+A local project will have no integration with any version control system, meaning that the files reside only on your hard drive. Any changes you make to the files are permanent and there is no way to revert changes or recover deleted files. It is recommended to use a version control system such as Git to track changes to your files. This also makes it very easy to collaborate on a project with other people. Uploading a local project to GitHub can be done in just a few steps:
+
+1. Create or login to an account on GitHub
+2. Create a repository using the [New Repository](https://help.github.com/en/articles/creating-a-new-repository) option
+3. Upload all project files via the [Upload Files](https://help.github.com/en/articles/adding-a-file-to-a-repository) option
+
+The project is now under version control and you should [clone the project](https://help.github.com/en/articles/cloning-a-repository) to your local hard drive and work from this new location instead.
+
 ## Importing a project
 
 Click the <kbd>Import Project</kbd> option to bring up a list of Defold hosted projects that you have access to. If you are not already signed in you must first do so. Specify a location on your hard drive where the project files will be stored.

+ 1 - 1
docs/en/manuals/workflow.md

@@ -25,7 +25,7 @@ Select a file in the list and click <kbd>Diff</kbd> to view the changes that you
 ## Synchronizing
 
 ::: important
-Project synchronization is only available for projects hosted on the Defold Dashboard. Projects hosted on GitHub or in other Git repositories will not be able to use synchronization.
+Project synchronization is only available for projects hosted on the Defold Dashboard. Projects hosted on GitHub or in other Git repositories will not be able to use synchronization. There are however many excellent external tools for working with Git repositories with [GitHub Desktop](https://desktop.github.com/), [GitTower](https://www.git-tower.com), [Git Kraken](https://www.gitkraken.com/git-client) and [SourceTree](https://www.sourcetreeapp.com/) being some of the more popular ones.
 :::
 
 To synchronize your project means that the project files are brought into sync with the project as it looks on the server. You should synchronize if:

+ 0 - 11
docs/en/shared/new-project.md

@@ -1,11 +0,0 @@
-## Creating a new game project
-
-Before you begin working on your game, you should set up storage for the game assets and code. The easiest way is to create a project on the Defold Dashboard. Doing so creates a Git repository on our cloud servers where your work is stored.
-
-1. Go to the [Defold Dashboard](//www.defold.com/dashboard/).
-2. Click New Project.
-3. Choose a name for the project and select *Start from a blank slate*.
-4. Click *Save* and you're done.
-
-![Add project](../shared/images/add_project.png)
-

+ 3 - 13
docs/en/tutorials/magic-link.md

@@ -19,7 +19,7 @@ This tutorial is written as a step-by-step guide where we build the game on a co
     <script src="//storage.googleapis.com/defold-doc/assets/dmloader.js"></script>
     <script src="//storage.googleapis.com/defold-doc/assets/dmengine_1_2_106.js" async></script>
     <script>
-        /* Load app on click in container. */
+        // Load app on click in container.
         document.getElementById("game-button").onclick = function (e) {
             var extra_params = {
                 archive_location_filter: function( path ) {
@@ -40,25 +40,15 @@ This tutorial is written as a step-by-step guide where we build the game on a co
 
 ## Getting started
 
-There are two ways you can follow this tutorial. Either you start a clean, empty project in Defold, download the asset package and build the game step-by-step.
+You need to start by creating a new project and importing the asset package:
 
-* Go to the [Defold Dashboard](//www.defold.com/dashboard/)
-* Click *New Project*
-* Choose a name for the project and select the "Empty Project" template
+* Create a [new project](/manuals/project-setup/#_creating_a_new_project) from the "Empty Project" template
 * Download the "Magic Link" asset package and unpack it on your hard drive (the package is a ZIP archive)
 
 <a class="btn btn-primary btn-xs-block btn-icon" href="//storage.googleapis.com/defold-doc/assets/magic-link-assets.zip">Download asset package<span aria-hidden="true" class="icon icon-download"></span></a>
 
 ![Magic Link asset pack](images/magic-link/linker_assets.png)
 
-The other option is to create a new project based on the "Magic Link" project template.
-
-* Go to the [Defold Dashboard](//www.defold.com/dashboard/)
-* Click *New Project*
-* Choose a name for the project and select the "Magic Link" template
-
-The new project will contain the fully functional game. You can browse the project files and use this tutorial as a guide to how everything is put together.
-
 ## Game rules
 
 ![Game rules schematic](images/magic-link/linker_rules.png)

+ 4 - 22
docs/en/tutorials/runner.md

@@ -17,7 +17,7 @@ In this tutorial we start with an empty project and build a complete runner game
   <script type='text/javascript' src="//storage.googleapis.com/defold-doc/assets/dmloader.js"></script>
   <script type='text/javascript' src="//storage.googleapis.com/defold-doc/assets/dmengine_1_2_106.js" async></script>
   <script type='text/javascript'>
-      /* Load app on click in container. */
+      // Load app on click in container.
       document.getElementById("game-button").onclick = function (e) {
           var extra_params = {
               archive_location_filter: function( path ) {
@@ -63,33 +63,15 @@ The first step is to download the following package. It is a zip package that co
 
 <a class="btn btn-primary btn-xs-block btn-icon" href="//storage.googleapis.com/defold-doc/assets/runner-assets.zip">Download asset package<span aria-hidden="true" class="icon icon-download"></span></a>
 
-Now it's time to create a new project and getting it ready. If you are familiar with the process, head over to [www.defold.com](//www.defold.com) and log in to the dashboard. If you are not familiar with the steps, here they are.
-
-* If you haven't yet signed up to be a Defold developer, do so!
-* When you signed up a "Getting Started Tutorial" project was created for you. Use this project for the tutorial.
-* Alternativly you can create a new project on the [Defold Dashboard](//www.defold.com/dashboard/). In this tutorial we choose to start from a blank slate.
-
-![The Dashboard](images/runner/1/dashboard.png)
-
-![Dashboard new project](images/runner/1/dashboard_new_project.png)
-
 Now, if you haven't already downloaded and installed the Defold editor, it's time to do that. You find the download link on the [Defold Dashboard](//www.defold.com/dashboard/). Then start the program.
 
 ![Download editor](images/runner/1/download_editor.png)
 
-## The editor
-
-The first time you start the editor, you will be prompted to log in to the Defold server where all your project data is stored. The editor starts blank, without any project open so choose <kbd>File ▸ Open Project</kbd> from the menu and select your newly created project. You will also be prompted to create a "branch" for the project.
+When the editor is started it's time to create a new project and getting it ready. Create a [new project](/manuals/project-setup/#_creating_a_new_project) from the "Empty Project" template.
 
-::: sidenote
-Defold uses Git to store and sync your code between different computers or team members. A branch is a local copy of the code that is stored on your computer and you can can have multiple branches if you are working on multiple versions of your game. You can name your branch anything, but we recommend naming it "master".
-
-For the Git savvy people---the branches you create in the editor are local branches only.
-
-When you do that a local copy of the whole project will be created on your computer. Any changes you do to the project will be saved in the branch. Whenever you select <kbd>File ▸ Synchronize</kbd> from the menu, your branch will be synchronized with the project on the Defold server. This means that your changes will be sent to the server and any changes that may have happened on the server is brought to your branch. If you're working in a team this is very powerful for collaboration.
+## The editor
 
-The [Workflow documentation](//www.defold.com/manuals/workflow) explains how all this works in more detail.
-:::
+The first time you start the editor, the editor starts blank, without any project open so choose <kbd>Open Project</kbd> from the menu and select your newly created project. You will also be prompted to create a "branch" for the project.
 
 Now, in the *Project Explorer* you will see all files that are part of the project. If you double-click the file "main/main.collection" the file will open up in the editor view in the center: