|
| 1 | +# The Software Design Lab WebPage Template |
| 2 | + |
| 3 | +Dear maintainer, this webpage was made using a jekyll theme that can be found [here](https://github.com/uwsampa/research-group-web). |
| 4 | + |
| 5 | +The source code can be found in develop branch. In master branch its only the result of the compilation. We are using a gem that makes easier to add a new publication but it cannot be used in the ci pipelines of github. |
| 6 | + |
| 7 | +You need to have ruby and jekyll installed in your computer. Then you have to clone the repository and change to develop branch. |
| 8 | + |
| 9 | +# Building the webpage |
| 10 | + |
| 11 | +Once you are in the development folder use ```jekyll build``` and ```jekyll serve --host 127.0.0.1 --port 8080``` see the result of the page. When all the changes have been done copy the content of the ```_site``` folder, change to master branch and replace all the content. I strongly recommend to run a local server to make sure all the changes are in the page. Then you can push your changes in both branches to the repo. |
| 12 | + |
| 13 | +# Maintaining this webpage |
| 14 | + |
| 15 | +--- |
| 16 | +## **Home Page** |
| 17 | +--- |
| 18 | + |
| 19 | +### **Slider** |
| 20 | + |
| 21 | +The photos that appear in the slider can be modified in the index.html. |
| 22 | + |
| 23 | +The images path are added in the file header. |
| 24 | + |
| 25 | +``` |
| 26 | +... |
| 27 | +image: /img/ICSME18LR.jpg |
| 28 | +image2: /img/news/BluehackTSDLSlider.jpeg |
| 29 | +image3: /img/DSC_0414_Original.jpg |
| 30 | +image4: /img/grace.jpg |
| 31 | +image5: /img/google18.jpg |
| 32 | +image6: /img/peru18.jpg |
| 33 | +... |
| 34 | +``` |
| 35 | + |
| 36 | +and then you have to had a new carrousel item replacing ```<imageKey>``` and ```<imageCaption>```: |
| 37 | + |
| 38 | +```html |
| 39 | +<div class="carousel-item"> |
| 40 | + <img class="d-block w-100" src="{{site.base}}{{ <imageKey> }}" alt="Team"> |
| 41 | + <div class="carousel-caption d-none d-md-block"> |
| 42 | + <h5> <imageCaption> </h5> |
| 43 | + </div> |
| 44 | +</div> |
| 45 | +``` |
| 46 | + |
| 47 | +### **News** |
| 48 | + |
| 49 | +News can be found in ```_posts``` folder. Everytime you create a news the file must be called like |
| 50 | +``` |
| 51 | +<year>-<month>-<day>-<newsID>.md |
| 52 | +``` |
| 53 | +And its content should be something like this: |
| 54 | +``` |
| 55 | +--- |
| 56 | +layout: post |
| 57 | +title: "ACM SIGSOFT Distinguished Paper Award" |
| 58 | +icon: trophy |
| 59 | +image: https://upload.wikimedia.org/wikipedia/commons/thumb/8/8e/Association_for_Computing_Machinery_%28ACM%29_logo.svg/300px-Association_for_Computing_Machinery_%28ACM%29_logo.svg.png |
| 60 | +shortnews: true |
| 61 | +--- |
| 62 | +
|
| 63 | +Mario Linares-Vásquez received an ACM DPA for his paper "Automatically Assessing Code Understandability: How Far Are We?", in Proceedings of 32nd IEEE/ACM International Conference on Automated Software Engineering (ASE'17), Urbana-Champaign, Illinois, USA, October 30 - November 3, 2017 |
| 64 | +``` |
| 65 | + |
| 66 | +Depending on the type of news the icon can be: |
| 67 | +| Type of news | icon key | |
| 68 | +|:---:|:---:| |
| 69 | +| New published paper | newspaper-o | |
| 70 | +| Award | trophy | |
| 71 | +| Talk | slideshare | |
| 72 | + |
| 73 | +The amount of news that are shown in the index is defined in the ```_config.yml``` using the key ```front_page_news```. |
| 74 | + |
| 75 | +--- |
| 76 | +## **People** |
| 77 | +--- |
| 78 | + |
| 79 | +People is modified in the ```_data/people.yml```. We have 5 posible roles in our research lab: |
| 80 | + |
| 81 | +| Role | Who has this role | |
| 82 | +|---|---| |
| 83 | +| faculty | Professors | |
| 84 | +| grad | Ph.D. and Ms. students | |
| 85 | +| ugrad | Undergraduate students | |
| 86 | +| collab | External Collaborators | |
| 87 | +| alum | Past students of TSDL | |
| 88 | + |
| 89 | +when a person is added to the ```people.yml``` file it must follow the following template: |
| 90 | + |
| 91 | +``` |
| 92 | +<id>: |
| 93 | + display_name: "<fullName>" |
| 94 | + role: "<role>" |
| 95 | + image: "/img/people/<imageName>.jpg" |
| 96 | + webpage: "<personalPageURL>" |
| 97 | + bio: "<description Of Current position>" |
| 98 | +``` |
| 99 | + |
| 100 | +Is important to see that if a person do not have a personal page that tag must be ommited. Also, alumni dont use either webpage or bio tag. |
| 101 | + |
| 102 | + |
| 103 | +--- |
| 104 | +## **Research Projects** |
| 105 | +--- |
| 106 | + |
| 107 | +Research projects can be found in ```_rschprojects/```. Each project has its own MarkDown file and usualy follow this template: |
| 108 | +``` |
| 109 | +--- |
| 110 | +title: "Mutation Testing" |
| 111 | +description: Mutation Testing is a type of software testing where we mutate (change) certain statements in the source code and check if the test cases are able to find the errors. It is a type of White Box Testing which is mainly used for Unit Testing. The changes in mutant program are kept extremely small, so it does not affect the overall objective of the program. In this moment, we have open projects in NodeJS and Android Framework |
| 112 | +
|
| 113 | +
|
| 114 | +people: |
| 115 | + - marioLinares |
| 116 | + - camiloEscobar |
| 117 | + - diegoRodriguez |
| 118 | + - collGabrieleBavota |
| 119 | + - collMassimiliano |
| 120 | + - collDenysPosh |
| 121 | +
|
| 122 | +topic: Software Testing |
| 123 | +layout: project |
| 124 | +image: /img/project-images/mutation.png |
| 125 | +
|
| 126 | +--- |
| 127 | +``` |
| 128 | + |
| 129 | +Right now the topic tag defines how they are group in the web page, currently we have 3 possible values: |
| 130 | +- Automated Software Engineering |
| 131 | +- Quality Attributes in Mobile Apps |
| 132 | +- Software Testing |
| 133 | + |
| 134 | +--- |
| 135 | +## **Software Development Projects** |
| 136 | +--- |
| 137 | +This projects follow this template: |
| 138 | +``` |
| 139 | +--- |
| 140 | +title: "FIND: A Software Platform Against Human Trafficking" |
| 141 | +description: Technological platform under development. This solution is being financed by the United Nations Office on Drugs and Crime. It includes an AI module based on IBM Watson, mobile applications and a dashboard. |
| 142 | +
|
| 143 | +
|
| 144 | +people: |
| 145 | + - dianaSolano |
| 146 | + - lauraBello |
| 147 | + - camiloEscobar |
| 148 | + - santiagoLinan |
| 149 | + - sergioYodeb |
| 150 | + - marioLinares |
| 151 | +link: https://thesoftwaredesignlab.github.io/blog/2018/09/01/bluehack.html |
| 152 | +layout: project |
| 153 | +image: /img/project-images/findBlueHack.jpg |
| 154 | +--- |
| 155 | +``` |
| 156 | + |
| 157 | +Here there is no topic and projects are shown directly, but there is a link tag that is important to fill. |
| 158 | + |
| 159 | +--- |
| 160 | +## **Publications** |
| 161 | +--- |
| 162 | + |
| 163 | +If you want to add a new publication to the page just copy the paper/journal bibtex content into ```bib/pubs.bib```. Jekyll and Jekyll-scholar will do all the magic and will generate a new entry. |
| 164 | + |
| 165 | +However, there are some important things to check before pushing your changes: |
| 166 | +1. New publications bibtex key must be meaninfull, we recommend to use: |
| 167 | +``` |
| 168 | +<firstLastnameOfFirstAuthor><Year><toolName|confName|journalName|meaningfulWor> |
| 169 | +--- |
| 170 | +linan2018rip |
| 171 | +linares2017cel |
| 172 | +rodriguez2018mutode |
| 173 | +``` |
| 174 | +2. If the bibtex has the keyworks tag and its content its to long its better to remove it because bibtex link in webpage generates a div whose height is based on the number of lines of the bibtex, if the keywords are too long the layout breaks. |
| 175 | + |
| 176 | +The filter over the publications is done in the ```publications.html``` file. In case you want to change something. |
| 177 | + |
| 178 | +--- |
| 179 | +## **Code** |
| 180 | +--- |
| 181 | + |
| 182 | + |
| 183 | +If you want to change the template that |
| 184 | + |
| 185 | + |
| 186 | + |
| 187 | + |
| 188 | + |
| 189 | + |
| 190 | + |
| 191 | + |
| 192 | + |
| 193 | + |
| 194 | + |
| 195 | + |
| 196 | + |
| 197 | + |
| 198 | + |
| 199 | + |
| 200 | + |
| 201 | + |
| 202 | + |
| 203 | + |
| 204 | + |
| 205 | + |
| 206 | + |
| 207 | + |
| 208 | + |
1 | 209 | Research Group Web Site Template
|
2 | 210 | ================================
|
3 | 211 |
|
@@ -58,7 +266,7 @@ For both long-form blog posts and short news updates, we use Jekyll's blogging s
|
58 | 266 | The file must begin with [YAML front matter][yfm]. For news updates, use this:
|
59 | 267 |
|
60 | 268 | ---
|
61 |
| - layout: post |
| 269 | + ` layout: post |
62 | 270 | shortnews: true
|
63 | 271 | ---
|
64 | 272 |
|
|
0 commit comments