Skip to content

Latest commit

 

History

History
19 lines (10 loc) · 1.85 KB

Best_Practices.md

File metadata and controls

19 lines (10 loc) · 1.85 KB
Raw

Ascend Project Best Practices and Examples

  • Case sensitivity for images, filenames, file paths, urls, etc. is critical. For example, My_image.jpg is not the same as my_image.jpg and /sites is not the same as /Sites.

  • Never put spaces in filenames, image names or directory names. Using the Finder to create or edit files and directories makes it very easy to make this mistake. Use the command line and use dashes, camelcase or underscores in your file and directory names.

    For example my_file.txt or my-file.txt or myFile.txt

  • The file path for your participant image directory is /participants/location/user/image_dir/image_name. It starts with a forward slash and follows the path from the root Ascend Project directory.

    For example /participants/portland/lisa/images/FromHawthorneBridge.jpg is the file path to my image directory.

  • You may find you want to embed a link to a previous blog post in a different blog post. The path to participant blog posts is a bit different than the path to participant images. The file path for your participant blogs is /participant/location/user/YYYY/MM/DD/blog_title/

    For example /participants/portland/lisa/2014/09/11/push_and_pull/ is the path to one of my Ascend blog posts.

  • Pay attention to spelling. The computer only does what you tell it to do so if you are trying to navigate somewhere or a link you embedded in your blog post claims to be invalid make sure everything is spelled correctly. Close enough won't work. The computer requires the spelling to be exact.

  • Test links in your web browser to make sure they lead to the page you were expecting. If you are still unsure you can always ask another participant to browse to the link on their computer.