Skip to content

Commit

Permalink
before push
Browse files Browse the repository at this point in the history
  • Loading branch information
Enjaileu committed Nov 13, 2023
1 parent 66a70c6 commit 45fa385
Show file tree
Hide file tree
Showing 21 changed files with 70 additions and 28 deletions.
2 changes: 1 addition & 1 deletion docs/user/basic-concepts/actions/actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ id: actions
title: Actions
sidebar_position: 20
---
This section describes the various actions you can execute in silex.
This section describes the various actions you can execute in silex or in silex integration in DCCs.
19 changes: 19 additions & 0 deletions docs/user/basic-concepts/actions/conform.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
id: conform
title: Conform
sidebar_position: 10
---
To conform = Include your scenes and assets in the pipeline.
## In Silex
![](../../../../static/img/user_guide/home_page/home_interface_conform.png)
Conform button is in the home page.
## In houdini
![](../../../../static/img/user_guide/actions/houdini_shelf/houdini_silex_shelf_conform.PNG)
Conform button is in the silex shelf.
## In Maya
![](../../../../static/img/user_guide/actions/maya_shelf/maya_silex_shelf_conforme.png)
Conform button is in the silex shelf.
## Action
![](../../../../static/img/user_guide/actions/conform/action_conform_01.PNG)
When you click on conform button, you are simply asked which file you want to conform. Then, to wich shot or asset your want to link it.
If **Auto select the conform type** is enable, Silex will automatically set your file according to its extension. But if you have any bugs, please disable it.
6 changes: 3 additions & 3 deletions docs/user/basic-concepts/actions/publish.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
id: publish
title: Publish
sidebar_position: 10
sidebar_position: 30
---
**Publish** is the action of sending a version of your files to a shared space.
To share your files with colleagues, you need to publish them. In fact, it's not your work files that will be shared, but a copy or export of them that will be saved on the network.
**Publish** is the action of sending a version of your files to a shared space. Basicaly, it's **exporting files for the next step in the pipeline.**
In fact, it's not your work files that will be shared, but a copy or export of them that will be saved on the network.
To use the renderfarm, all you files submitted must have been published.

## In Houdini
Expand Down
8 changes: 5 additions & 3 deletions docs/user/basic-concepts/actions/save.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ id: save
title: Save
sidebar_position: 20
---
Do we really have to explain what **save** means?

## In Houdini
![](../../../../static/img/user_guide/actions/houdini_shelf/houdini_silex_shelf_save.PNG)
In the silex shelf, **1** is increment save, **2** is save.
Expand All @@ -13,10 +15,10 @@ In the silex shelf, **1** is increment save, **2** is save.

## Save
Your work files are saved in the hierarchy as follows:
- shot : D:/project/{pfe}/shots/{sequence}/{shot}/{task}/work/{pfe}_{sequence}_{shot}_{task}_work_{version}.{extension}
- asset : D:/project/{pfe}/assets/{asset type}/{asset name}/{task}/work/{pfe}_{asset type}_{asset name}_{task}_work_{version}.{extension}
- shot : ```D:/project/{pfe}/shots/{sequence}/{shot}/{task}/work/{pfe}_{sequence}_{shot}_{task}_work_{version}.{extension}```
- asset : ```D:/project/{pfe}/assets/{asset type}/{asset name}/{task}/work/{pfe}_{asset type}_{asset name}_{task}_work_{version}.{extension}```

For example, this means that the cfx file for shot 01-010 can be found here : D:/project/testpipe/shots/s01/p010/cfx_main/work/testpipe_s01_p010_cfx_main_work_v001.hipnc
For example, this means that the cfx file for shot 01-010 can be found here : ```D:/project/testpipe/shots/s01/p010/cfx_main/work/testpipe_s01_p010_cfx_main_work_v001.hipnc```

As you can see, the file has a version. If you work on your file and click on **save** button, your updates will be saved on the same file. If you click on **increment save**, a new version will be created. Example : testpipe\_s01_p010_cfx_main_work\_**v001**.hipnc will become testpipe\_s01_p010_cfx_main_work\_**v002**.hipnc.

Expand Down
24 changes: 3 additions & 21 deletions docs/user/interface/interface.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,7 @@ sidebar_position: 30
---

## Home page

![](/img/silex_logo.png)

---

Hello newbies ! 🖖

Welcome to Silex, a pipeline application which gives you access to the render farm and allows you to browse through your shots and assets, and many other things ! (you'll see, it's very fun)

When opening Silex, you just need to connect with your Kitsu acount.
after that, the home page will be displayed.

Expand Down Expand Up @@ -51,15 +43,13 @@ This section displays your account avatar, the Nimby status, access to the list

1- Hamberger menu.

2- Update button : Reload the interface (useful if some newly created files don't show or if new features don't appear). You can use the **very precious** CTRL + R [shortcut](../shortcuts.md) to trigger the same result.
2- Update button : Reload the interface (useful if some newly created files don't show or if new features don't appear). You can use the **very precious** CTRL + R [shortcut](shortcuts) to trigger the same result.

3- List of running software :

![](/img/user_guide/home_page/silex_home_page_running_software.png)

4- Nimby : allows you to turn on/off the [nimby](nimby.md).

5- Account profile :
4- Account profile :

![](/img/user_guide/home_page/silex_home_page_profile.png)

Expand All @@ -76,12 +66,4 @@ This menu gives you acces to all the services on Silex.
- **Project explorer** : This is a [file explorer](file-explorer.md) that let you browse through the files in your projects.
- **Actions** : This shows all running [actions](../basic-concepts/actions/actions.md) on you computer.

- **Statistics** : This represents the rendered frames progression of each team through the year. Try and reach the top as fast as you can 📈.

- **Arcade** : Here you can find flappy-bird like games, inspired by promo2022 movies. Play them to win some Silex coins ! (But not to much)

- **Tractor** : Tractor is the school [renderfarm](../renderfarm/renderfarm.md).

- **Harvest** : This will redirect you to [Harvest](../harvest/harvest.md). A statistic tool relaying different information on the renderfarm.

- **Ticket** : Access to the ticket system. see with the TDs if they are using it.
- **Ticket** : Access to the [tickets](tickets.md) system.
6 changes: 6 additions & 0 deletions docs/user/interface/shortcuts.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
id: shortcuts
title: Shortcuts
sidebar_position: 30
---
**\[ctrl\] + \[R\]** : refresh silex desktop interface.
27 changes: 27 additions & 0 deletions docs/user/interface/tickets.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
id: tickets
title: Tickets Page
sidebar_position: 40
---

![](../../../static/img/user_guide/tickets_page/ticket_page.PNG)

Direct link to our discord channel. Click on **"ouvrir l'application"** to open it in the discord app. The button "continuer dans le navigateur" is not working.
## A good ticket
Write a good ticket makes your TD happy :\) Here are the instructions:

**Start your ticket by :**
Room : *room number*
PC : *computer tqg*
Student : *Name Lastname*
PFE : *PFE name*

Example :
Salle : 108
PC : MH15-2023-006
Etudiant : Mauran Perrone
PFE : Rescue

If you are working on several PFE, write the one you have a problem with.

Specify the version of the soft (is it Houdini Arnold or Houdini Vray?), add screenshot if relevent, give us as many detail you can.
6 changes: 6 additions & 0 deletions docs/user/presentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,11 @@ title: Presentation
sidebar_position: 10
---

![](/img/silex_logo.png)

Hello newbies ! 🖖

Welcome to Silex, a pipeline application which gives you access to the render farm and allows you to browse through your shots and assets, and many other things ! (you'll see, it's very fun)

**Silex** (pronounced /ˈsaɪlɛks/) is the name given to a set of pipeline applications here at ArtFX.
It was originally created for the 2021-2022 promotion.
Empty file.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/user_guide/home_page/silex_home_page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/user_guide/home_page/silex_home_page_frame_top.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/user_guide/home_page/silex_home_page_hamburger.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/user_guide/home_page/silex_home_page_profile.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 45fa385

Please sign in to comment.