Skip to content

Commit 68cdd87

Browse files
committed
Update CONTRIBUTING.md
1 parent 390f4ed commit 68cdd87

File tree

1 file changed

+0
-47
lines changed

1 file changed

+0
-47
lines changed

CONTRIBUTING.md

Lines changed: 0 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -162,53 +162,6 @@ Although this workaround required add the following to conf.py and pinning promp
162162

163163
**Follow-up for next round of dependency updates:** Another workaround could be to use the pip IPython package instead of the conda one (there’s mention the conda one might be buggy), then maybe you don’t need to add that to conf.py or fix prompt-toolkit.
164164

165-
#### Build the website locally
166-
167-
1. Test your setup by building the docs. Run the following from the project root to build the docs.
168-
169-
```
170-
make html
171-
```
172-
173-
2. It is usual to see a lot of warnings. It’s a good idea to try to address them. Some projects treat warnings as errors and will fail the build.
174-
3. Serve the content locally:
175-
176-
```
177-
cd _build/html
178-
python -m http.server 8000
179-
```
180-
181-
4. Either open the index.html file in the `_build/html` directory, or navigate in the browser to: `http://0.0.0.0:8000/`
182-
183-
184-
#### Add a notebook to the website
185-
186-
You will modify the index.rst file at the highest level of the directory and add the notebook by name, minus the extension into the section that corresponds to the folder in which you added the notebook. For example, if the new notebook is in a subfolder in the `generative_ai` folder:
187-
https://github.com/aws/amazon-sagemaker-examples/blob/default/generative_ai/sm-jumpstart_foundation_finetuning_gpt_j_6b_domain_adaptation.ipynb
188-
You would modify this file: https://github.com/aws/amazon-sagemaker-examples/blob/default/index.rst
189-
190-
191-
1. Look for the table of contents directive, `toctree` with the caption that matches the subfolder you placed the notebook into:
192-
193-
```
194-
195-
.. toctree::
196-
:maxdepth: 1
197-
:caption: Generatative AI
198-
199-
```
200-
201-
2. Add an entry for the new notebook:
202-
203-
```
204-
205-
.. toctree::
206-
:maxdepth: 1
207-
:caption: Generatative AI
208-
209-
generative_ai/sm-jumpstart_foundation_finetuning_gpt_j_6b_domain_adaptation
210-
```
211-
212165
#### Adjusting navigation
213166

214167
Some pages have nested title elements that will impact the navigation and depth. The following shows the title, using the top and bottom hash marks (####). Then the single line equals sign (====), then the dashes (----). These are equivalent to H1, H2, and H3, respectively.

0 commit comments

Comments
 (0)