Skip to content

Commit 72dc209

Browse files
authored
Update README.rst
1 parent 8e1615d commit 72dc209

File tree

1 file changed

+17
-14
lines changed

1 file changed

+17
-14
lines changed

README.rst

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ The simplest and quickest way to edit is directly in the GitHub web
2828
interface. It has an editor, previewer, and lets you commit
2929
changes. You won't need to install any local tools. The previewer
3030
knows how to render RST, but not the sphinx directives so it will not
31-
display exactly as the real manual.
31+
display exactly as the real document.
3232

3333
-------------------------
3434
Working with a Local Copy
@@ -42,7 +42,7 @@ to do the same task manually.
4242
Setup
4343
-----
4444

45-
Install Python 3 and doxygen (>= 1.8.17). To install on **Ubuntu**::
45+
Install Python 3, doxygen (>= 1.8.17), latex, etc. To install on **Ubuntu**::
4646

4747
sudo scripts/install.sh
4848

@@ -60,9 +60,6 @@ On Windows::
6060
python scripts\oneapi.py spec-venv
6161
spec-venv\Scripts\activate
6262
63-
MKL and Level Zero are temporarily in separate private repos. If you have access to the repos, you can clone them::
64-
65-
python scripts/oneapi.py clones
6663

6764
Building the docs
6865
-----------------
@@ -71,10 +68,6 @@ To build the html document::
7168

7269
python scripts/oneapi.py html
7370

74-
This will not work on Windows because we are using symbolic links for
75-
the elements that are in separate repos. However, Windows can build
76-
individual specs for individual elements.
77-
7871
The document is organized as a book with chapters. Each element of
7972
oneAPI is its own chapter and can be built separately. For example, to
8073
build the oneVPL chapter, do::
@@ -116,6 +109,18 @@ size of the text. Probably a lot more.
116109
linting. I could not find any support for rejustifying paragraphs to
117110
80 characters, which makes it difficult to use.
118111

112+
------------------
113+
Submitting changes
114+
------------------
115+
116+
Changes are submitted as PR's to this repo. It's up to you how you get
117+
to the point of making the PR. If you have write access to this repo, you
118+
can push a feature branch to this repo, and then do the PR from the feature
119+
branch. If you work this way, the CI will publish HTML, PDF to the staging
120+
server. You can also fork this repo and do the PR from your fork. CI will
121+
build the document and save the results as an artifact, but will not
122+
publish to staging server.
123+
119124
------
120125
Docker
121126
------
@@ -137,11 +142,11 @@ CI
137142

138143
We use GitHub actions. See `<.github/workflows/main.yml>`_
139144

140-
On every commit, the CI system builds and publishes the document to
145+
On every commit to every branch, the CI system builds and publishes the document to
141146
the staging server. To see the URL, look at the end of the log for the
142147
build step in the CI system. The staging server is an s3 bucket, and
143148
the access keys are managed as GitHub action secrets. PR's based on
144-
forks do not have access to the keys and will not publish on the
149+
forks do not have access to the keys and will build, but not publish on the
145150
staging server.
146151

147152
For commits to the publish branch, the document is staged inside a
@@ -164,9 +169,7 @@ production with::
164169

165170
python scripts/oneapi.py prod-publish
166171

167-
Then purge the CDN. Generate a list of URLs with::
168-
169-
python scripts/oneapi.py purge
172+
Then purge the CDN.
170173

171174
------------
172175
More Reading

0 commit comments

Comments
 (0)