Skip to content

Commit

Permalink
consortium-investors document updated - see static/files and latest d…
Browse files Browse the repository at this point in the history
…ocument changelog
  • Loading branch information
Sion committed Apr 8, 2021
1 parent 9a9c539 commit 8d56a75
Show file tree
Hide file tree
Showing 543 changed files with 32,570 additions and 1,879 deletions.
15 changes: 12 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

## [0.0.1-rtw.11] - Q2/2021

### Changed
07-Apr - Worked on static/files/ (datro-consortium/consortium-investors) - see static/files/CHANGELOG.md and changelog in document for details
05-Apr - Minor edit to static/datro/documents.html - see corresponding changelog for details

### Fixed
05-Apr - Minor security fix in static/datro - see corresponding changelog for details

## [0.0.1-rtw.10] - Q1/2021

### Added
Expand All @@ -17,7 +26,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
14-Jan - evr-network.live in GoDaddy forwards to evrnetwork.datro.world, then the javascript in the netlify splashpage brings up the website

### Changed
25-Mar - link to facebook was incorrect on datro website, fixed it sitewide
25-Mar - link to facebook was incorrect on datro website, fixed it sitewide
10-Mar - minor typo correction - see static/hbnb/changelog.md
07-Mar - see static/gui changelog
24-Feb - fetch.html changed in static/gui/app-store/apps/xxx-xxx/ - see corresponding changelog for details
Expand Down Expand Up @@ -96,5 +105,5 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- I installed the php extension imagick.so to the localmachine and php.ini file and it's throwing up an apache error with the demo
- But weirdly not the wordpress websites. I installed it to clear a wordpress health report error. All we know at this point.

[Unreleased]: https://github.com/unclehowell/hbnb/compare/v0.0.1-rtw.7...HEAD
[0.0.1-rtw.7]: https://github.com/unclehowell/hbnb/compare/v0.0.1-rc.7...v0.0.1-rtw.7
[Unreleased]: https://github.com/unclehowell/hbnb/compare/v0.0.1-rtw.11...HEAD
[0.0.1-rtw.10]: https://github.com/unclehowell/hbnb/compare/v0.0.1-rc.10...v0.0.1-rtw.10
12 changes: 12 additions & 0 deletions static/datro/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,18 @@ and [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

## [static-datro.03] - Q2/2021

### Changed
05-Apr - Intro text on docs page was re-written.
05-Apr - Changed the semantic version and the prefix of this directory - the full semantic version is now `0.0.1-rtw.11-static-datro.03`
- `0.0.1-rtw.11` is the branch e.g. "Release to Web (RTW)"
- `static-datro.03` is added to the end to reflect this subdirectories version'
- must find a way to use semantic version badges on the published content too to save viewing the changelogs for version numbers

### Fixed
05-Apr - There was a security vunerablity in html/videos/package-lock.json - fixed it as per github's suggestion (upping the version of a package to the latest)

## [0.0.2] - Q1/2021

### Added
Expand Down
2 changes: 1 addition & 1 deletion static/datro/documents.html
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@
<h1 class="segment-title">Documents</h1>
<div class="container marketing" style="margin-top:-2em;margin-bottom:3em;">
<div class="container">
<p class="product-paragraph" style="margin-top:40px!important;margin-bottom: 7em!important;">DATR<span class="copy-left">&#xa9;</span>'s documents are stored without our public source-code MonoREAPo as reStructuredText, along with this entire website. Which is how we're able to present the content of our MonoREAPo in such a friendly way. This also allows us to present each compiled document in html and as a downlable PDF. Furthmore, PDF's are compiled into multiple languages, while the html view of the document is inherently translated when the websites language is changed. We also use our own enhanced semantic version control methodology to manage re-releases of the documents &nbsp;<a data-featherlight="iframe" data-featherlight-iframe-allowfullscreen="true" href="html/docs-intro.html" style=""><u>Learn More</u></a></p>
<p class="product-paragraph" style="margin-top:40px!important;margin-bottom: 7em!important;">DATR<span class="copy-left">&#xa9;</span>'s documents are stored in our public source-code MonoREAPo as ReStructuredText, alongside this entire website. Which is how we're able to present the content of our MonoREAPo in such a friendly way. This method also allows us to compile each document as HTML and PDF, for your viewing pleasure. We also use our own enhanced semantic version control methodology to manage re-releases of the documents &nbsp;<a data-featherlight="iframe" data-featherlight-iframe-allowfullscreen="true" href="html/docs-intro.html" style=""><u>Learn More</u></a></p>
</div>
</div>
<div class="container" id="products">
Expand Down
6 changes: 3 additions & 3 deletions static/datro/html/videos/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

56 changes: 34 additions & 22 deletions static/files/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,55 +6,67 @@ and [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

## [files.03] - Q1/2021

## [files.03] - Q2/2021

### Added
27-Mar - Trying to get docs library to work with readthedocs by adding .readthedocs.yml
27-Mar - Trying to get docs library to work with readthedocs by adding .readthedocs.yml

### Fixed
05-Apr - The custom.sh script file in some docs (which pulls spreadsheet data in) was producing errors. Appended a `--location` to curl which fixed it

### Changed
07-Apr - worked on datro-consortium/consortium-investors v0.1.6 then archived, ran `make clean` and began work on v0.1.7 e.g. latest
07-Apr - Moved archives to netlify branch and called it `wayback`
05-Apr - Moved archived content from each document directory to /static/archives

### To Do
06-Apr - Solve Table numbering in Sphinx. Table numbering restarts on every new chapter

## [0.0.2] - Q3/2020

### Added
- GNU General Public License - site-wide
- removed scrollbars completely - see the `master-rebuild.sh` script in the `_blue-build-source` directory
- GNU General Public License - site-wide
- removed scrollbars completely - see the `master-rebuild.sh` script in the `_blue-build-source` directory

### Changed
- Re-structured directory (ongoing)... and re-branded, from Wave, to HotspotBnB, to DATRO
- HotspotBnB and Wave are now spin-off/subsidiary projects of DATRO
- Renamed `static/demo` directory to `static/gui`. It may double up as a demo for HBnB, but it's actually the actual GUI
- Re-structured directory (ongoing)... and re-branded, from Wave, to HotspotBnB, to DATRO
- HotspotBnB and Wave are now spin-off/subsidiary projects of DATRO
- Renamed `static/demo` directory to `static/gui`. It may double up as a demo for HBnB, but it's actually the actual GUI

### Removed
- Copyright (from Sphinx html docs)
- Copyright (from Sphinx html docs)

### Fixed
- The frame the docs are displayed in (featherlight) was scrolling upwards off screen, whenever you selected the doc. Fixed it!
- Copyleft symbol wasn't appearing on chrome on android. Reversed copyright symbol using css instead.
- changed background color to theme, the white default was making the website look poor between page refreshes
- the dropdown in the footers seems to work locally now, let's see if it works when the sites pushed to gh-pages.
- The frame the docs are displayed in (featherlight) was scrolling upwards off screen, whenever you selected the doc. Fixed it!
- Copyleft symbol wasn't appearing on chrome on android. Reversed copyright symbol using css instead.
- changed background color to theme, the white default was making the website look poor between page refreshes
- the dropdown in the footers seems to work locally now, let's see if it works when the sites pushed to gh-pages.

### To Do
- Add Copyleft to Sphinx html docs, where copyright used to be (now that displaying the copyleft symbol has been resolved)
- Add Copyleft to Sphinx html docs, where copyright used to be (now that displaying the copyleft symbol has been resolved)

### Issues

## [0.0.1-rtw.7] - 2020-06-24
### Added
- two important folders introduced, dynamic and static. static is for all the static websites, dynamic for the server-side backend/ CMS's etc.
- added the Latex docs library under the directory /static/files (/static/docs is the website to view the files)
- two important folders introduced, dynamic and static. static is for all the static websites, dynamic for the server-side backend/ CMS's etc.
- added the Latex docs library under the directory /static/files (/static/docs is the website to view the files)

### Changed
- altered the content of the CHANGELOG.md to relate specifically to this (gh-pages-dev) branch e.g. website development, not software development
- moved all the hiden (server-side) folders into the dynamic directory. And made the folders visible (removed the dots from the start of the name)
- altered the content of the CHANGELOG.md to relate specifically to this (gh-pages-dev) branch e.g. website development, not software development
- moved all the hiden (server-side) folders into the dynamic directory. And made the folders visible (removed the dots from the start of the name)

### Removed
-

### Fixed

- Semantic version is standard, other than v0.0.x-rc.x is for software (master branches) and v0.0.x-rtw.x is for websites (gh-pages branches)
- Semantic version is standard, other than v0.0.x-rc.x is for software (master branches) and v0.0.x-rtw.x is for websites (gh-pages branches)

### Issues
- I installed the php extension imagick.so to the localmachine and php.ini file and it's throwing up an apache error with the demo
- But weirdly not the wordpress websites. I installed it to clear a wordpress health report error. All we know at this point.
- I installed the php extension imagick.so to the localmachine and php.ini file and it's throwing up an apache error with the demo
- But weirdly not the wordpress websites. I installed it to clear a wordpress health report error. All we know at this point.

[Unreleased]: https://github.com/unclehowell/hbnb/compare/v0.0.1-rtw.7...HEAD
[0.0.1-rtw.7]: https://github.com/unclehowell/hbnb/compare/v0.0.1-rc.7...v0.0.1-rtw.7
[Unreleased]: https://github.com/unclehowell/hbnb/compare/v0.0.1-rtw.7...HEAD
[0.0.1-rtw.7]: https://github.com/unclehowell/hbnb/compare/v0.0.1-rc.7...v0.0.1-rtw.7
18 changes: 9 additions & 9 deletions static/files/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ c) this method keeps the depth of the file structure to 2. Which the custom auto
## The File Structure

Top Level Directory we call "TLD"
--depth 1 contains the sphinx document source-code directories (also containing compile scripts and compiled html & pdf)
--depth 1 contains the sphinx document source-code directories (also containing compile scripts and compiled html & pdf)

TLD directories are labeled `subsidiaryID`
followed by a dash (`-`) and then `categoryID`.
Expand Down Expand Up @@ -97,7 +97,7 @@ The low depth of the Files Library is also important for the custom scripts to f
| ├── 'technical - development_guide'
| ├── 'slideshow - product_intro'
```

## How it Works

Within each "Top Level" Directory are sphinx document folders, which contains two sub directories:
Expand Down Expand Up @@ -147,7 +147,7 @@ Understanding Git is crucial e.g. Pull, Push, etc. (Git Desktop GUI for Windows
### Other Dependencies

```
apt install texlive-latex-base texlive-fonts-recommended texlive-fonts-extra texlive-latex-extra
apt install texlive-latex-base texlive-fonts-recommended texlive-fonts-extra texlive-latex-extra texlive-luatex
pip3 install -U sphinx (updates sphinx so that extension 'sphinx.ext.autosectionlabel' works).
Expand All @@ -158,7 +158,7 @@ sudo apt install latexmk
sudo apt-get install xdg-utils
```

To open index.html & *.pdf from commandline use xdg-open e.g. `xdg-open build/html/index.html` or `xdg-open build/latex/business-plan.pdf`
To open index.html & *.pdf from commandline use xdg-open e.g. `xdg-open build/html/index.html` or `xdg-open build/latex/business-plan.pdf`


## Getting Started
Expand All @@ -174,7 +174,7 @@ Remember in both cases to following the file structure, as explained at the top
### New Version
Before a new version of a document can be produced, you must archive the current version.
If there are existing versions, you will see them as the titles of the sub-directories in the sphinx document directory e.g. 0-0-1, 0-0-2 etc
Obviously the current version you are archieving, will be labelled as the next in the sequence e.g. 0-0-3
Obviously the current version you are archiving, will be labeled as the next in the sequence e.g. 0-0-3

1. Create a folder entitled x-x-x (the version number).

Expand Down Expand Up @@ -215,14 +215,14 @@ It's also best practice to number and title each image as follows .. Fig 1.0 - I
The consistent method of doing this is as follows:

* **Fig 1.0** - *Image Title*
*
*
The first star creates a bullet point which is the best way to center align the text.
The Fig x.x is in bold (using the two stars are the beginning and end)
The Image Title is in italics (using the single star at the beginning and end)
If the text above the image overflows then forget bullet pointing the line.

## Source Files (self-updating build script)
These source files work in conjuntion with the update-all process:
These source files work in conjuntion with the update-all process:

- Update-all is our way of bulk rebuilding all the documents in this Files Library.
- There's an update-all.sh in each sub-directory e.g. management, services, hardware etc
Expand All @@ -233,7 +233,7 @@ These source files work in conjuntion with the update-all process:
The purpose of the script files contained in this directory are as follows:

**updater.sh** : gets the latest copy of the two *-master.sh files (it only allow itself to be run twice an hour to reduce server traffic)
**rebuild-master.sh** : found in every sphinx document folder (entitled rebuild.sh),it custom builds the rst files into PDF and HTML and updates the auto-rebuild
**rebuild-master.sh** : found in every sphinx document folder (entitled rebuild.sh),it custom builds the rst files into PDF and HTML and updates the auto-rebuild
**auto-rebuild-master.sh** : placed in every sphinx document folder (entitled auto-rebuild.sh). Used by update-all.sh to update the rebuild.sh file before running it.


Expand All @@ -242,7 +242,7 @@ The purpose of the script files contained in this directory are as follows:
The directory structure and file locations are as follows:

```
_blue-build-source/
_blue-build-source/
- updater.sh
- rebuild-master.sh
Expand Down
34 changes: 0 additions & 34 deletions static/files/_blue-build-source/auto-rebuild-master.sh

This file was deleted.

49 changes: 0 additions & 49 deletions static/files/_blue-build-source/update.sh

This file was deleted.

34 changes: 0 additions & 34 deletions static/files/_grey-build-source/auto-rebuild-master.sh

This file was deleted.

Loading

0 comments on commit 8d56a75

Please sign in to comment.