Skip to content

Commit

Permalink
finalized Fire Within blog
Browse files Browse the repository at this point in the history
  • Loading branch information
KevinAst committed Mar 22, 2022
1 parent 209c38b commit 5503624
Show file tree
Hide file tree
Showing 3 changed files with 53 additions and 122 deletions.
56 changes: 52 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

- [Overview]
- [Internal Notes]
- [Author Fire Within Blog]
- [Publish Web Content]
- [Revision History]

Expand Down Expand Up @@ -47,31 +48,73 @@ requiring this directory structure. **All other files are project
specific web page content!**


## Author Fire Within Blog

The "Fire Within" blog is compiled using [GitBook]. The master source
is found in `MyWeb/FireWithin/`.

To run the dev process (that will re-compile on any change):

```shell
$ cd MyWeb
$ npm run blog:dev
```

And run your web-server, pointing to: `MyWeb/MyPage/`.


## Publish Web Content

To publish the content, simply:

```shell
$ cd MyWeb
$ npm run publish:web
```

TEST: https://wiibridges.com/

**Notes:**
- This can be run **anytime** _(for patches)_ from **any branch** _(although typically master)_.
- For `Fire Within` blog changes:
- update FireWithin version _(found in `MyWeb/FireWithin/toc.md`)_
- update FireWithin history _(found in `MyWeb/FireWithin/history.md`)_
- check into branch
- PR to master
- For significant changes:
- update web version _(found in `package.json`)_
- update change history _(below)_
- PR to master branch
- check into branch
- PR to master
- tag the release _(ex: **v1.1.0**)_


## Revision History

Release | What | *When*
---------|-------------------------------------------------|------------------
[v2.0.0] | Added Fire Within Blog | *March 22, 2022*
[v1.2.0] | eatery-nod-w | *June 7, 2019*
[v1.1.0] | Misc Changes | *September 20, 2018*
[v1.0.0] | Initial Release | *September 13, 2018*


### v2.0.0 - Added Fire Within Blog *(March 22, 2022)*

<ul><ul><!--- indentation hack for github - other attempts with style is stripped (be careful with number bullets) --->

[GitHub Content](https://github.com/KevinAst/MyWeb/tree/v2.0.0)
&bull;
[GitHub Release](https://github.com/KevinAst/MyWeb/releases/tag/v2.0.0)
&bull;
[Diff](https://github.com/KevinAst/MyWeb/compare/v1.2.0...v2.0.0)

- added "Fire Within" blog

</ul></ul>



<!-- *** RELEASE *************************************************************** -->

### v1.2.0 - eatery-nod-w *(June 7, 2019)*
Expand Down Expand Up @@ -147,10 +190,14 @@ Release | What | *When*
</ul></ul>

<!--- *** REFERENCE LINKS *** --->
[Overview]: #overview
[Internal Notes]: #internal-notes
[Publish Web Content]: #publish-web-content
[Overview]: #overview
[Internal Notes]: #internal-notes
[Author Fire Within Blog]: #author-fire-within-blog
[Publish Web Content]: #publish-web-content


[Revision History]: #revision-history
[v2.0.0]: #v200---added-fire-within-blog-march-22-2022
[v1.2.0]: #v120---eatery-nod-w-june-7-2019
[v1.1.0]: #v110---misc-changes-september-20-2018
[v1.0.0]: #v100---initial-release-september-13-2018
Expand All @@ -160,3 +207,4 @@ Release | What | *When*
[resume]: https://startbootstrap.com/template-overviews/resume/
[creative]: https://startbootstrap.com/template-overviews/creative/
[agency]: https://startbootstrap.com/template-overviews/agency/
[GitBook]: https://docs.gitbook.com/
117 changes: 0 additions & 117 deletions TOOLING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,6 @@ c:/data/tech/dev/project/MyWeb/projectSetup.txt).
- [Initialize NPM Project]
- [Setup Blog Tooling]
- [Setup wiiBridges.com domain]
- [Publish to Web]
- [Setup New Feature Branch]


<!--- *** SECTION *************************************************************** --->
# NPM Scripts
Expand Down Expand Up @@ -595,120 +592,6 @@ wiiBridges.com domain.
FYI: See details of this at c:/data/tech/isp/domain.GitHubDNS.txt.
<!--- *** SECTION *************************************************************** --->
# Publish to Web
This section chronicles the steps in publishing **MyWeb** to wiiBridges.com.
AI: Most of the following needs to be reviewed and NIXed. What I typically do:
```
quick publish (from next3 branch)
* PUBLISH WEB ... do in PowerShell
$ cd C:\dev\MyWeb
$ npm run publish:web
* test:
https://wiibridges.com/
```
**Feature Branch**:
Typically all development is done in a **feature branch**. If you are
about to deploy, presumably your branch is complete and documented.
1. insure all tests are operational
```
$ npm run test
```
2. finalize version -and- history notes:
- for the new version, use [semantic standards](http://semver.org/)
- update version in:
* `package.json`
* `blog/toc.md` (version is referenced at top)
* `blog/history.md` (within the "running" notes)
- review/finalize all blog impacted by change
* also insure README.md does NOT need to change
- optionally: save a link-neutral version of change history comments (to use in git tagging)
* pull from history.md _(normalizing any reference links)_
* ALTERNATE: simply reference the history section (in the git tag)
EX: https://MyWeb.js.org/history.html#v0_1_0
**main Branch**:
1. issue PR (pull request) and merge to main branch
2. sync main to local machine (where the deployment will occur)
3. verify version is correct in:
* `package.json`
* `blog/toc.md`
* `blog/history.md`
4. now, everything should be checked in to main and ready to publish
5. tag the release (in github)
* verify the history page github links are correct (now that the tag exists)
6. publish **MyWeb** to npm **_(THIS IS IT!)_**:
```
$ npm publish
+ [email protected]
```
verify publish was successful
- receive email from npm
- npm package: https://www.npmjs.com/package/MyWeb
- unpkg.com: https://unpkg.com/MyWeb/
7. publish **MyWeb** page:
```
$ npm run blog:publish ... NO NO NO
```
verify publish site was successful
- https://MyWeb.js.org/
* see new version
* see correct history
8. optionally test the new package in an external project (by installing it)
<!--- *** SECTION *************************************************************** --->
# Setup New Feature Branch
This section documents the steps to setup a new **feature branch**
(where all development is typically done):
1. create a new branch (typically spawned from the "main" branch).
**EX**: `next7`
2. devise "best guess" as to the next version number _(may be
premature, but this can subsequently change)_.
Reflect this in:
* `package.json`
* `blog/toc.md` (version is referenced at top)
* `blog/history.md` (within the "running" notes)
3. setup new running Revision History (in `blog/history.md`)
This provides a place where we can incrementally maintain "running"
revision notes.
<!--- *** LINKS ***************************************************************** --->
[NPM Scripts]: #npm-scripts
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "MyWeb",
"version": "1.2.0",
"version": "2.0.0",
"description": "My Web Page",
"homepage": "https://wiibridges.com/",
"scripts": {
Expand Down

0 comments on commit 5503624

Please sign in to comment.