ENDOC-314 new links on Getting Started draft #346

jyunmitch · 2021-11-17T20:20:02Z

This is a draft and need to assess links, layout and new text.
Also, when approved, will be added to next version.

nshaw · 2021-11-17T20:49:00Z

vuepress/docs/v6.3.2/docs/getting-started/README.md

-2. [Manually install Entando step by step](#manual-install). This permits configuration of either a shared cluster or a local developer environment. A manual install is appropriate when CLI defaults don't meet specific needs, or to customize the deployment.
+## Try Entando
+
+Set up Entando using two simple steps or install manually for your specific needs. Then try the platform with a simple widget or walk through the **Welcome Wizard** in our AppBuilder. For a more in-depth experience, check out our **Banking demo**.


We should probably update the language to Standard Banking Demo rather than Banking demo or Standard Demo. That's what the tutorial is called now.

Glossary - App Builder, instead of AppBuilder.

i think it's important to keep 1. and 2. above. they provide pertinent information.

never mind! i just got to where you moved that info to. it flows nicely to introduce things vaguely then hit the details time-of. on the other hand 1. and 2. clue the user into which install they'd like to follow and quickly compare the two... me not knowing anything i'd like the info up front, but someone with experience would probably know which path to take and then get a refresh on the particulars :)

nshaw · 2021-11-17T20:49:27Z

vuepress/docs/v6.3.2/docs/getting-started/README.md

+* [Quick Local Install](https://dev.entando.org/v6.3.2/docs/getting-started/#automatic-install)	
+The fastest way to start up Entando in Kubernetes.
+
+* [Manual Install](https://dev.entando.org/v6.3.2/docs/getting-started/#manual-insta)	


Link looks broken to me - should be #manual-install

nshaw · 2021-11-17T20:49:55Z

vuepress/docs/v6.3.2/docs/getting-started/README.md

+  Once you're setup, check out:
+    * [Build a simple Bundle and create an App](https://dev.entando.org/v6.3.2/tutorials/ecr/publish-simple-bundle.html)
+    * [Welcome Wizard](https://dev.entando.org/v6.3.2/docs/getting-started/welcome-wizard.html)
+    * [Install our Banking Demo](https://dev.entando.org/v6.3.2/tutorials/samples/install-standard-demo.html)


Same, Standard Banking Demo

nshaw · 2021-11-17T20:50:45Z

vuepress/docs/v6.3.2/docs/getting-started/README.md

+
+## Learn about Entando
+
+Learn about what Entando can do top down or explore the elements that make automating containers with Kubernetes easier.


"make automating containers with Kubernetes" is too specific, "quickly developing applications on Kubernetes" would be preferable

nshaw · 2021-11-17T20:51:57Z

vuepress/docs/v6.3.2/docs/getting-started/README.md

+
+Learn about what Entando can do top down or explore the elements that make automating containers with Kubernetes easier.
+
+* [Introduction to Entando ](https://dev.entando.org/v6.3.2/docs/)	


Style guide-wise, all links should be relative links, meaning do not include the full URL. I think there are notes on that in the README. If you include the full URL, these links will not point to the correct location in different environments, e.g. local, staging, etc.

@nshaw please give an example of how to turn a full url link into a relative one?

Relative means the path to the new page is relative to the location of the current page. So ./abc/def.md would check in the current location for an abc folder and then display the def.md in that folder. You can also use .. to go up a level (or more levels with ../.. or ../../.., etc.) , e.g. ../docs/getting-started/ to go up one level then into docs and getting started. You can also skip the path altogether and just use #section-name if you're referencing a different section in the current page. Unless you're pointing to an external web site we want to avoid anything with dev.entando.org in it and even v6.3.2, for maintenance reasons.

nshaw · 2021-11-17T20:52:47Z

vuepress/docs/v6.3.2/docs/getting-started/README.md

+
+
+
+<!-- 1. [Automatically install Entando via the Entando command-line interface (CLI)](#automatic-install). This is the fastest way to initialize an Entando application in Kubernetes. A CLI install defaults certain settings and prepares a local developer environment.


General principle, we don't leave commented code in docs or actual code since it can always be found in the git history. Comment sections clutter the code and make it harder to maintain.

nshaw · 2021-11-17T21:00:36Z

vuepress/docs/v6.3.2/docs/getting-started/README.md

+
+Set up Entando using two simple steps or install manually for your specific needs. Then try the platform with a simple widget or walk through the **Welcome Wizard** in our AppBuilder. For a more in-depth experience, check out our **Banking demo**.
+
+* [Quick Local Install](https://dev.entando.org/v6.3.2/docs/getting-started/#automatic-install)	


We should keep the same language - maybe Automatic Install here but expand the note to indicate it's local, "The fastest way to locally install and start up Entando in Kubernetes".

Lyd1aCla1r3 · 2021-11-17T21:10:33Z

vuepress/docs/v6.3.2/docs/getting-started/README.md

-2. [Manually install Entando step by step](#manual-install). This permits configuration of either a shared cluster or a local developer environment. A manual install is appropriate when CLI defaults don't meet specific needs, or to customize the deployment.
+## Try Entando
+
+Set up Entando using two simple steps or install manually for your specific needs. Then try the platform with a simple widget or walk through the **Welcome Wizard** in our AppBuilder. For a more in-depth experience, check out our **Banking demo**.


i think it's important to keep 1. and 2. above. they provide pertinent information.

Lyd1aCla1r3 · 2021-11-17T21:15:54Z

vuepress/docs/v6.3.2/docs/getting-started/README.md

-2. [Manually install Entando step by step](#manual-install). This permits configuration of either a shared cluster or a local developer environment. A manual install is appropriate when CLI defaults don't meet specific needs, or to customize the deployment.
+## Try Entando
+
+Set up Entando using two simple steps or install manually for your specific needs. Then try the platform with a simple widget or walk through the **Welcome Wizard** in our AppBuilder. For a more in-depth experience, check out our **Banking demo**.


never mind! i just got to where you moved that info to. it flows nicely to introduce things vaguely then hit the details time-of. on the other hand 1. and 2. clue the user into which install they'd like to follow and quickly compare the two... me not knowing anything i'd like the info up front, but someone with experience would probably know which path to take and then get a refresh on the particulars :)

vuepress/docs/v6.3.2/docs/getting-started/README.md

Lyd1aCla1r3 · 2021-11-17T21:19:40Z

vuepress/docs/v6.3.2/docs/getting-started/README.md

+
+Learn about what Entando can do top down or explore the elements that make automating containers with Kubernetes easier.
+
+* [Introduction to Entando ](https://dev.entando.org/v6.3.2/docs/)	


@nshaw please give an example of how to turn a full url link into a relative one?

nshaw · 2021-11-18T20:50:56Z

vuepress/docs/v6.3.2/docs/getting-started/README.md

-2. [Manually install Entando step by step](#manual-install). This permits configuration of either a shared cluster or a local developer environment. A manual install is appropriate when CLI defaults don't meet specific needs, or to customize the deployment.
+## Try Entando
+
+Set up Entando using two simple steps or install manually for your specific needs. Then try the platform with a simple widget or walk through the **Welcome Wizard** in our App Builder. For a more in-depth experience, check out our **Standard Banking demo**.


Demo instead of demo.

nshaw · 2021-11-18T20:53:26Z

vuepress/docs/v6.3.2/docs/getting-started/README.md

+The fastest way to locally install and start up Entando in Kubernetes.
+
+* [Manual Install](#manual-install):
+Useful if you want a shared cluster or customize. 


Maybe "or custom local instance"

nshaw · 2021-11-18T20:53:55Z

vuepress/docs/v6.3.2/docs/getting-started/README.md

+Useful if you want a shared cluster or customize. 
+
+  Once you're setup, check out:
+    * [Build a simple Bundle and create an App](../../tutorials/ecr/publish-simple-bundle.html)


Whitespace matters so I think you're getting extra indentation because of the spaces on this list.

nshaw · 2021-11-18T20:54:36Z

vuepress/docs/v6.3.2/docs/getting-started/README.md



 ## Automatic Install
-The following steps will launch an Ubuntu VM via Multipass, install Kubernetes, and then deploy Entando to it.
+Automatically install Entando via the Entando command-line interface (CLI) and prepare a local developer environment with defaults settings.


"defaults settings" feels wrong. Maybe just "default settings".

nshaw · 2021-11-18T20:56:43Z

vuepress/docs/v6.3.2/docs/getting-started/README.md


-::: tip What's Needed to Run Kubernetes?
+**What's Needed to Run Kubernetes?**


Minor, but I think it looked better as separate tips? They aren't actually related tips.

nshaw

A few comments and then we need the /next change as well.

nshaw

Looks good!

ENDOC-314 new links on Getting Started draft

17bd8d0

jyunmitch added the draft First version of text, not an edit. label Nov 17, 2021

jyunmitch requested review from nshaw and Lyd1aCla1r3 November 17, 2021 20:20

nshaw reviewed Nov 17, 2021

View reviewed changes

Lyd1aCla1r3 reviewed Nov 17, 2021

View reviewed changes

jyunmitch added 2 commits November 18, 2021 13:47

New quick links in Getting started page

c497681

change right nav for Overview to Introduction

eff0377

nshaw reviewed Nov 18, 2021

View reviewed changes

nshaw requested changes Nov 18, 2021

View reviewed changes

New links on getting started page in v6.3.2 and next

b6a6584

nshaw approved these changes Nov 18, 2021

View reviewed changes

nshaw merged commit c86e127 into main Nov 19, 2021

nshaw deleted the ENDOC-314 branch November 19, 2021 12:46

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ENDOC-314 new links on Getting Started draft #346

ENDOC-314 new links on Getting Started draft #346

jyunmitch commented Nov 17, 2021 •

edited

Loading

nshaw Nov 17, 2021

nshaw Nov 17, 2021

Lyd1aCla1r3 Nov 17, 2021

Lyd1aCla1r3 Nov 17, 2021

jyunmitch Nov 18, 2021

nshaw Nov 17, 2021

nshaw Nov 17, 2021

nshaw Nov 17, 2021

nshaw Nov 17, 2021

Lyd1aCla1r3 Nov 17, 2021

nshaw Nov 18, 2021

nshaw Nov 17, 2021

nshaw Nov 17, 2021

Lyd1aCla1r3 Nov 17, 2021

Lyd1aCla1r3 Nov 17, 2021

Lyd1aCla1r3 Nov 17, 2021

nshaw Nov 18, 2021

nshaw Nov 18, 2021

nshaw Nov 18, 2021

nshaw Nov 18, 2021

nshaw Nov 18, 2021

nshaw left a comment

nshaw left a comment


		## Learn about Entando

		Learn about what Entando can do top down or explore the elements that make automating containers with Kubernetes easier.


		Learn about what Entando can do top down or explore the elements that make automating containers with Kubernetes easier.

		* [Introduction to Entando ](https://dev.entando.org/v6.3.2/docs/)




		<!-- 1. [Automatically install Entando via the Entando command-line interface (CLI)](#automatic-install). This is the fastest way to initialize an Entando application in Kubernetes. A CLI install defaults certain settings and prepares a local developer environment.


		Set up Entando using two simple steps or install manually for your specific needs. Then try the platform with a simple widget or walk through the Welcome Wizard in our AppBuilder. For a more in-depth experience, check out our Banking demo.

		* [Quick Local Install](https://dev.entando.org/v6.3.2/docs/getting-started/#automatic-install)


		::: tip What's Needed to Run Kubernetes?
		What's Needed to Run Kubernetes?

ENDOC-314 new links on Getting Started draft #346

ENDOC-314 new links on Getting Started draft #346

Conversation

jyunmitch commented Nov 17, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nshaw left a comment

Choose a reason for hiding this comment

nshaw left a comment

Choose a reason for hiding this comment

jyunmitch commented Nov 17, 2021 •

edited

Loading