singa-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From GitBox <...@apache.org>
Subject [GitHub] [singa-doc] FeynmanDNA commented on a change in pull request #10: Update instructions for documentation
Date Wed, 01 Apr 2020 14:46:15 GMT
FeynmanDNA commented on a change in pull request #10: Update instructions for documentation
URL: https://github.com/apache/singa-doc/pull/10#discussion_r401672541
 
 

 ##########
 File path: docs-site/README.md
 ##########
 @@ -1,80 +1,69 @@
-# Apache SINGA docs-site (README still work in progress)
+# Apache SINGA Website
 
-## Docusaurus Website Local Set Up
+## Local Set Up
 
-This website was created with [Docusaurus](https://docusaurus.io/).
+This website is created with [Docusaurus](https://docusaurus.io/). To set up the website
locally,
 
-You need at least `node` and `yarn` to get started with setting up a local development environment.
+1. Install [yarn](https://classic.yarnpkg.com/en/docs/install/#debian-stable)
 
-1. Start from the SINGA root directory, install any website specific dependencies by `yarn
install`.
+2. Install [node](https://askubuntu.com/a/548776) (version>=10).
+
+3. Install dependencies
 
 ```sh
-# Install dependencies
+# in singa-doc/docs-site folder
 $ yarn install
 ```
 
-2.  Run a development server with hot-reloading to check changes by running `yarn start`
in the website directory.
+4. Run a development server with hot-reloading which updates the webpages immediately upon
the modifications to the source files,
 
 ```sh
-# Start the site
+# in singa-doc/docs-site folder
 $ yarn run start:website
 ```
 
-## Docs for the Docusaurus Site
-
-All the docs are located in the `docs` folder.
-
-"Versioned documents are placed into `website/versioned_docs/version-${version}`, where `${version}`
is the version number you supplied the `version` script... If you wish to change the documentation
for a past version, you can access the files for that respective version. (https://docusaurus.io/docs/en/versioning.html#storing-files-for-each-version)
-
-"Documents in the `docs` directory will be considered part of version `next` and they are
available, for example, at the URL `docs/next/doc1.html`. Documents from the latest version
use the URL `docs/doc1.html`" (https://docusaurus.io/docs/en/versioning)
-
-## News for the Docusaurus Site
+## Generate Static HTML Files for Deployment
 
-All the news are located in the `website/blog/` folder.
+To create a static build of your website, run the following script from the `website` directory:
 
-# Editing Content
-
-## Static assets
+```sh
+$ yarn run build # or npm run build`"
 
 Review comment:
   extra `" at the end

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

Mime
View raw message