Home | History | Annotate | only in /docs/source.android.com
Up to higher level directory
NameDateSize
en/06-Dec-2017
ja/06-Dec-2017
ko/06-Dec-2017
README.txt06-Dec-20171.9K
ru/06-Dec-2017
zh-cn/06-Dec-2017
zh-tw/06-Dec-2017

README.txt

      1 # HOW TO UPDATE SOURCE.ANDROID.COM #
      2 
      3 Googlers, please see: go/sac-guide
      4 
      5 The source.android.com site contains tutorials, references, and other
      6 information related to the Android Open Source Project (AOSP). To report an
      7 issue with the documentation on source.android.com, please file a bug at:
      8 https://issuetracker.google.com/issues/new?component=191476
      9 
     10 To make updates to the source files themselves, follow the instructions below.
     11 
     12 ### File Location ###
     13 
     14 The source.android.com source files are stored in the platform/docs/source.android.com/
     15 Android project:
     16 https://android.googlesource.com/platform/docs/source.android.com/
     17 
     18 The files to be edited are located in: <projroot>/docs/source.android.com/<language-code>/
     19 
     20 Subdirectories exist for the tabs of source.android.com with their structure
     21 roughly (but not identically) mirroring navigation of the site. For exceptions,
     22 the contents of the Porting tab can be found in the devices/ subdirectory,
     23 while the contents of the Tuning tab reside in the devices/tech subdirectory.
     24 (This is temporary while navigational changes are underway.)
     25 
     26 ## Edit Instructions ##
     27 
     28 1. Initialize and sync the repository and download the Android source per:
     29 https://source.android.com/source/downloading.html
     30 
     31 2. Navigate to the docs/source.android.com project.
     32 
     33 3. Start a temporary branch for your changes with a command resembling:
     34 $ repo start <topic-branch-name> .
     35 
     36 See the Repo command reference for more details:
     37 http://source.android.com/source/using-repo.html#start
     38 
     39 4. Add or edit the file(s) and save your changes:
     40 $ git add <file>
     41 $ git commit
     42 $ repo upload .
     43 
     44 5. Iteratively improve the change and amend the commit:
     45 $ git commit -a --amend
     46 $ repo upload .
     47 
     48 6. Once satisfied, include the changelist in a bug filed at:
     49 https://issuetracker.google.com/issues/new?component=191476
     50 
     51 Your change will be routed to the source.android.com team for evaluation and
     52 inclusion.
     53