Merge pull request #18 from BeamStackProj/fixes

Fixes

Author: olufunbi

README.md

@@ -12,26 +12,18 @@ use GitHub pull requests for this purpose. Consult
 [GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
 information on using pull requests.
 
-## Updating a single page
-
-If you've just spotted something you'd like to change while using the docs, Docsy has a shortcut for you:
-
-1. Click **Edit this page** in the top right hand corner of the page.
-1. If you don't already have an up to date fork of the project repo, you are prompted to get one - click **Fork this repository and propose changes** or **Update your Fork** to get an up to date version of the project to edit. The appropriate page in your fork is displayed in edit mode.
-1. Follow the rest of the [Quick start with Netlify](#quick-start-with-netlify) process above to make, preview, and propose your changes.
-
-## Previewing your changes locally
+## Proposing & previewing your changes locally
 
 If you want to run your own local Hugo server to preview your changes as you work:
 
 1. Follow the instructions in [Getting started](/docs/getting-started) to install Hugo and any other tools you need. You'll need at least **Hugo version 0.45** (we recommend using the most recent available version), and it must be the **extended** version, which supports SCSS.
 1. Fork the [Website repo](https://github.com/BeamStackProj/website) repo into your own project, then create a local copy using `git clone`. Don’t forget to use `--recurse-submodules` or you won’t pull down some of the code you need to generate a working site.
 
     ```
-    git clone --recurse-submodules --depth 1 https://github.com/BeamStackProj/website.git
+    git clone --recurse-submodules --depth 1 https://github.com/BeamStackProj/website
     ```
 
-1. Run `hugo server` in the site root directory. By default your site will be available at http://localhost:1313/. Now that you're serving your site locally, Hugo will watch for changes to the content and automatically refresh your site.
+1. Run `hugo server` in the site root directory. By default your site will be available at http://localhost:1313/website. Now that you're serving your site locally, Hugo will watch for changes to the content and automatically refresh your site.
 1. Continue with the usual GitHub workflow to edit files, commit them, push the
   changes up to your fork, and create a pull request.
 

content/en/blog/news/first-post/index.md

@@ -1,11 +1,11 @@
 ---
 date: 2024-08-15
-title: Easy documentation with Docsy
-linkTitle: Announcing Docsy
+title: Announcing Beamstack
+linkTitle: Announcing Beamstack
 description: >
   The Docsy Hugo theme lets project maintainers and contributors focus on content,
   not on reinventing a website infrastructure from scratch
-author: Riona MacNamara ([@rionam](https://twitter.com/bepsays))
+author: Olufunbi Babalola
 resources:
   - src: "**.{png,jpg}"
     title: "Image #:counter"

content/en/docs/about/community.md

@@ -12,7 +12,7 @@ Come join us and make Beamstack better, we are looking for contributors to add c
 Please join the [Beamstack Discord](https://discord.gg/fYNnNVaEFK).
 
 <a href="https://discord.gg/fYNnNVaEFK">
-  <button class="btn btn-primary py-2 px-5 mb-3">Click to join:<br><b>Beamstack Slack</b></button>
+  <button class="btn btn-primary py-2 px-5 mb-3">Click to join:<br><b>Beamstack Discord</b></button>
 </a>
 
 <img src="{{< param prefixURL >}}/docs/about/images/featured-background.png"

content/en/docs/about/contributing.md

@@ -19,8 +19,7 @@ Follow these instructions if you want to:
 
 ### Joining the Beamstack GitHub Org
 
-- First step is to join the discord channel
-- In the [join-beamstack](https://discord.gg/5jxWcupaQM) channel, create a request to join the org
+- First step is to join the [discord channel](https://discord.gg/fYNnNVaEFK)
 - Follow the prompts to get onboarded
 
 ### Contributing to the Beamstack Project

content/en/docs/about/contribution-guidelines.md

@@ -6,7 +6,7 @@ weight: 20
 
 We use [Hugo](https://gohugo.io/) to format and generate our website, the
 [Docsy](https://github.com/google/docsy) theme for styling and site structure,
-and [Netlify](https://www.netlify.com/) to manage the deployment of the site.
+and [Github Actions](https://docs.github.com/en/actions) to manage the deployment of the site.
 Hugo is an open-source static site generator that provides us with templates,
 content organisation in a standard directory structure, and a website generation
 engine. You write the pages in Markdown (or HTML if you want), and Hugo wraps them up into a website.
@@ -16,53 +16,24 @@ use GitHub pull requests for this purpose. Consult
 [GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
 information on using pull requests.
 
-## Quick start with Netlify
-
-Here's a quick guide to updating the docs. It assumes you're familiar with the
-GitHub workflow and you're happy to use the automated preview of your doc
-updates:
-
-1. Fork the [Beamstack repo](https://github.com/google/docsy-example) on GitHub.
-1. Make your changes and send a pull request (PR).
-1. If you're not yet ready for a review, add "WIP" to the PR name to indicate
-  it's a work in progress. (**Don't** add the Hugo property
-  "draft = true" to the page front matter, because that prevents the
-  auto-deployment of the content preview described in the next point.)
-1. Wait for the automated PR workflow to do some checks. When it's ready,
-  you should see a comment like this: **deploy/netlify — Deploy preview ready!**
-1. Click **Details** to the right of "Deploy preview ready" to see a preview
-  of your updates.
-1. Continue updating your doc and pushing your changes until you're happy with
-  the content.
-1. When you're ready for a review, add a comment to the PR, and remove any
-  "WIP" markers.
-
-## Updating a single page
-
-If you've just spotted something you'd like to change while using the docs, Docsy has a shortcut for you:
-
-1. Click **Edit this page** in the top right hand corner of the page.
-1. If you don't already have an up to date fork of the project repo, you are prompted to get one - click **Fork this repository and propose changes** or **Update your Fork** to get an up to date version of the project to edit. The appropriate page in your fork is displayed in edit mode.
-1. Follow the rest of the [Quick start with Netlify](#quick-start-with-netlify) process above to make, preview, and propose your changes.
-
-## Previewing your changes locally
+## Proposing & previewing your changes locally
 
 If you want to run your own local Hugo server to preview your changes as you work:
 
 1. Follow the instructions in [Getting started](/docs/getting-started) to install Hugo and any other tools you need. You'll need at least **Hugo version 0.45** (we recommend using the most recent available version), and it must be the **extended** version, which supports SCSS.
-1. Fork the [Beamstack repo](https://github.com/google/docsy-example) repo into your own project, then create a local copy using `git clone`. Don’t forget to use `--recurse-submodules` or you won’t pull down some of the code you need to generate a working site.
+1. Fork the [Website repo](https://github.com/BeamStackProj/website) repo into your own project, then create a local copy using `git clone`. Don’t forget to use `--recurse-submodules` or you won’t pull down some of the code you need to generate a working site.
 
     ```
-    git clone --recurse-submodules --depth 1 https://github.com/google/docsy-example.git
+    git clone --recurse-submodules --depth 1 https://github.com/BeamStackProj/website
     ```
 
-1. Run `hugo server` in the site root directory. By default your site will be available at http://localhost:1313/. Now that you're serving your site locally, Hugo will watch for changes to the content and automatically refresh your site.
+1. Run `hugo server` in the site root directory. By default your site will be available at http://localhost:1313/website. Now that you're serving your site locally, Hugo will watch for changes to the content and automatically refresh your site.
 1. Continue with the usual GitHub workflow to edit files, commit them, push the
   changes up to your fork, and create a pull request.
 
 ## Creating an issue
 
-If you've found a problem in the docs, but you're not sure how to fix it yourself, please create an issue in the [Beamstack repo](https://github.com/google/docsy-example/issues). You can also create an issue about a specific page by clicking the **Create Issue** button in the top right hand corner of the page.
+If you've found a problem in the docs, but you're not sure how to fix it yourself, please create an issue in the [Website repo](https://github.com/BeamStackProj/website/issues). You can also create an issue about a specific page by clicking the **Create Issue** button in the top right hand corner of the page.
 
 ## Useful resources
 

content/en/docs/getting-started/installing-beamstack.md

@@ -25,7 +25,6 @@ beamstack -h
 5. You should see a list of available beamstack commands if installed properly.
 
 ## Next steps
-
-- Review our [introduction to Beamstack](/docs/getting-started/introduction/).
-- Explore the [architecture of Beamstack](/docs/getting-started/architecture).
 - Check out [beamstack code examples](/docs/getting-started/examples/).
+
+

content/en/docs/getting-started/introduction.md

@@ -31,7 +31,7 @@ Deploying machine learning and GenAI workflows should be easy. By extension, man
 
 ## The Beamstack mission
 
-Our goal is to make the deployment of AI/ML Pipelines effortless and time efficienct. Beamstack extends already existing features of kubernetes: 
+Our goal is to make the deployment of AI/ML Pipelines effortless and time efficient. Beamstack extends already existing features of kubernetes: 
 
 - Easy, repeatable, portable deployments on a diverse infrastructure
   (for example, experimenting on a laptop, then moving to an on-premises
@@ -53,5 +53,5 @@ There are many ways to contribute to Beamstack, and we welcome contributions!
 Read the [contributor's guide](/docs/about/contributing/) to get started on the code, and learn about the community on the [community page](/docs/about/community/).
 
 ## Next Steps
-
+- Explore the [architecture of Beamstack](/docs/getting-started/architecture).
 - Follow [the installation guide](/docs/getting-started/installing-beamstack) install Beamstack and begin easy pipeline deployments.

hugo.yaml

@@ -48,7 +48,7 @@ languages:
     languageName: English
     title: Beamstack
     params:
-      description: A Docsy example site
+      description: Beamstack Project Documentation
   # cSpell:disable
   # cSpell:enable
 

package.json

@@ -3,11 +3,11 @@
   "version": "0.10.0",
   "version.next": "0.10.1-dev.0-unreleased",
   "description": "Beamstack Project Documentation",
-  "repository": "github:BeamStackProj/beamstack-cli",
+  "repository": "github:BeamStackProj/website",
   "homepage": "https://beamstackproj.github.io/website",
-  "author": "Docsy Authors",
+  "author": "Beamstack",
   "license": "Apache-2.0",
-  "bugs": "https://github.com/BeamStackProj/beamstack-cli/issues",
+  "bugs": "https://github.com/BeamStackProj/website/issues",
   "spelling": "cSpell:ignore docsy hugo htmltest precheck postbuild -",
   "scripts": {
     "_build": "npm run _hugo-dev --",