victor HF staff pcuenq HF staff commited on
Commit
8427e34
1 Parent(s): 9f45aaa

typos / nits (#17)

Browse files

- typos / nits (edf9444200c8b8656ffbc5bb872552a3b54bbf6c)


Co-authored-by: Pedro Cuenca <[email protected]>

Files changed (1) hide show
  1. README.md +10 -10
README.md CHANGED
@@ -9,7 +9,7 @@ pinned: false
9
 
10
 
11
  <div class="not-prose bg-gradient-to-r from-gray-50-to-white text-gray-900 border" style="border-radius: 8px; padding: 0.5rem 1rem;">
12
- <span style="font-weight: 600;">Spaces Dev Mode is currently in beta.</span> It's available for <a target="_blank" class="underline" href="https://huggingface.co/subscribe/pro" style="color: inherit;">PRO</a> users (personnal Spaces) or <a target="_blank" href="https://huggingface.co/enterprise" style="color: inherit;">Enterprise</a> organizations (org Spaces).
13
  </div>
14
 
15
  <div class="not-prose bg-gradient-to-r from-gray-50-to-white text-gray-900 border" style="border-radius: 8px; padding: 0.5rem 1rem; margin-top: 10px;">
@@ -60,10 +60,10 @@ The application does not restart automatically when you change the code. For you
60
  ### Persisting changes
61
 
62
  <div class="alert alert-warning">
63
- The changes you make when the Dev Mode is enabled are not persisted to the Space repo automatically.
64
- By default, they will be discarded when the Dev Mode is disabled or when the Space goes to sleep.
65
  </div>
66
- If you wish to persist changes made while the Dev Mode is enabled, you need to use `git` from inside the Space container (using VS Code or SSH). For example:
67
 
68
  ```shell
69
  # Add changes and commit them
@@ -79,7 +79,7 @@ The modal will display a warning if you have uncommitted or unpushed changes in
79
 
80
  ![image/png](https://cdn-uploads.huggingface.co/production/uploads/5fcfb7c407408029ba3577e2/r6Uk1YyvE2-hzsKTSRvnR.png)
81
 
82
- ### How to enable the Dev Mode
83
 
84
  Go to your Space's settings and click on "Enable Dev Mode".
85
 
@@ -87,7 +87,7 @@ Go to your Space's settings and click on "Enable Dev Mode".
87
  ![image/png](https://cdn-uploads.huggingface.co/production/uploads/5fcfb7c407408029ba3577e2/31fExSYIPyxgXm-B9uL4d.png)
88
 
89
 
90
- You can also enable the Dev Mode from the quick actions dropdown.
91
 
92
 
93
  ![image/png](https://cdn-uploads.huggingface.co/production/uploads/5fcfb7c407408029ba3577e2/t2nQI_5kXY53QIVqBkIx6.png)
@@ -95,11 +95,11 @@ You can also enable the Dev Mode from the quick actions dropdown.
95
 
96
  ## Limitations
97
 
98
- The Dev Mode is currently not available for static Spaces. Docker Spaces also have some additional requirements.
99
 
100
  ### Docker Spaces
101
 
102
- Dev Mode is supported for Docker Spaces. However, your Space needs to comply with the following rules for the Dev Mode to work properly.
103
 
104
  1. The following packages must be installed:
105
 
@@ -113,9 +113,9 @@ Dev Mode is supported for Docker Spaces. However, your Space needs to comply wit
113
 
114
  4. The Dockerfile must contain a `CMD` instruction for startup. Checkout [Docker's documentation](https://docs.docker.com/reference/dockerfile/#cmd) about the `CMD` instruction for more details.
115
 
116
- The Dev Mode works well when the base image is debian-based (eg, ubuntu).
117
 
118
- More exotic linux distros (eg, alpine) are not tested and the Dev Mode is not guaranteed to work on them.
119
 
120
  ### Example of compatible Dockerfiles
121
 
 
9
 
10
 
11
  <div class="not-prose bg-gradient-to-r from-gray-50-to-white text-gray-900 border" style="border-radius: 8px; padding: 0.5rem 1rem;">
12
+ <span style="font-weight: 600;">Spaces Dev Mode is currently in beta.</span> It's available for <a target="_blank" class="underline" href="https://huggingface.co/subscribe/pro" style="color: inherit;">PRO</a> users (personal Spaces) or <a target="_blank" href="https://huggingface.co/enterprise" style="color: inherit;">Enterprise</a> organizations (org Spaces).
13
  </div>
14
 
15
  <div class="not-prose bg-gradient-to-r from-gray-50-to-white text-gray-900 border" style="border-radius: 8px; padding: 0.5rem 1rem; margin-top: 10px;">
 
60
  ### Persisting changes
61
 
62
  <div class="alert alert-warning">
63
+ The changes you make when Dev Mode is enabled are not persisted to the Space repo automatically.
64
+ By default, they will be discarded when Dev Mode is disabled or when the Space goes to sleep.
65
  </div>
66
+ If you wish to persist changes made while Dev Mode is enabled, you need to use `git` from inside the Space container (using VS Code or SSH). For example:
67
 
68
  ```shell
69
  # Add changes and commit them
 
79
 
80
  ![image/png](https://cdn-uploads.huggingface.co/production/uploads/5fcfb7c407408029ba3577e2/r6Uk1YyvE2-hzsKTSRvnR.png)
81
 
82
+ ### How to enable Dev Mode
83
 
84
  Go to your Space's settings and click on "Enable Dev Mode".
85
 
 
87
  ![image/png](https://cdn-uploads.huggingface.co/production/uploads/5fcfb7c407408029ba3577e2/31fExSYIPyxgXm-B9uL4d.png)
88
 
89
 
90
+ You can also enable Dev Mode from the quick actions dropdown.
91
 
92
 
93
  ![image/png](https://cdn-uploads.huggingface.co/production/uploads/5fcfb7c407408029ba3577e2/t2nQI_5kXY53QIVqBkIx6.png)
 
95
 
96
  ## Limitations
97
 
98
+ Dev Mode is currently not available for static Spaces. Docker Spaces also have some additional requirements.
99
 
100
  ### Docker Spaces
101
 
102
+ Dev Mode is supported for Docker Spaces. However, your Space needs to comply with the following rules for Dev Mode to work properly.
103
 
104
  1. The following packages must be installed:
105
 
 
113
 
114
  4. The Dockerfile must contain a `CMD` instruction for startup. Checkout [Docker's documentation](https://docs.docker.com/reference/dockerfile/#cmd) about the `CMD` instruction for more details.
115
 
116
+ Dev Mode works well when the base image is debian-based (eg, ubuntu).
117
 
118
+ More exotic linux distros (eg, alpine) are not tested and Dev Mode is not guaranteed to work on them.
119
 
120
  ### Example of compatible Dockerfiles
121