Difference between revisions of "Editing the Wiki"

From Jubilee
Jump to navigation Jump to search
Line 7: Line 7:
  
 
===Links and Uploads===
 
===Links and Uploads===
The wiki will always support the most up-to-date version of the project. As such, ''links to design files that are subject to change between version (i.e: files from Github) should point to those files, not local copies on the wikis''.
 
  
Specifically, do not upload the following file formats directly to the wiki.
+
====Design Files====
* STL
+
Design files are subject to change between versions. As such, do not upload design files to the wiki. Rather link them to the file in the ''master'' branch of the [https://github.com/machineagency/jubilee project repository.]
* STEP
 
* PDFs of dimensioned drawings or assembly instructions
 
* Native Solidworks formats, *.slddrw, *.sldprt, *.sldasm, *.
 
 
 
Instead, link these files to the ''master'' branch of the [https://github.com/machineagency/jubilee project repository.]
 
  
 
Exception: aesthetic-only or placeholder images that clearly point to the most up-to-date version are OK.
 
Exception: aesthetic-only or placeholder images that clearly point to the most up-to-date version are OK.

Revision as of 21:28, 7 May 2020

Syntax

Wiki Conventions

Project Versions

The wiki will always reference the most up-to-date version of the project. Information related to older versions should (1) either explicitly mention this up front or (2) create and older page and link to it from the current page.

Links and Uploads

Design Files

Design files are subject to change between versions. As such, do not upload design files to the wiki. Rather link them to the file in the master branch of the project repository.

Exception: aesthetic-only or placeholder images that clearly point to the most up-to-date version are OK.