Remake get started #1091
Remake get started #1091
Conversation
rma-rudder
requested review from
amousset and
ncharles
and removed request for
amousset
| Now you can go to our node details by using the quick search filter, and searching for *node* | ||
| (it's our node's hostname). | ||
| Let's look at our node compliance in details. Click on: | ||
|
|
||
| Go to the *Compliance reports* tab. You will see the applied policy and the current compliance | ||
| regarding it. If you click on a line it will unfold until you get to the actual applied | ||
| component. | ||
| . *Nodes* menu | ||
| . the node hostname *server* | ||
| . the *Compliance* tab | ||
| . unfold in clicking on *Global configuration for all nodes* in the screen lower part |
There was a problem hiding this comment.
👍 for using the menu.
But I find the steps so concise that it overall looks a bit harsh.
For example we could explain what we will do before guiding the user :
For that, first open the node details page and navigate in the compliance tree :
* <steps ...>
| @@ -6,61 +6,60 @@ | |||
|
|
|||
| In this section you will: | |||
|
|
|||
| * Use policy building blocks in the builder UI | |||
| * Use Rudder's technique editor building blocks | |||
There was a problem hiding this comment.
| * Use Rudder's technique editor building blocks | |
| * Use building blocks within the technique editor in Rudder |
| We can now name our technique: *Demo user*, and add a small description for documentation: | ||
| We can now name our technique: _Demo user_, and add a small description for documentation: | ||
|
|
||
| image::./new.png["New technique form", align="center"] |
There was a problem hiding this comment.
the image is no longer added, and it looks intentional because the previous image already explains it. So, the : should be replaced by .
| Let's start using methods to build a technique. Click on: | ||
|
|
||
| image::./demo.png["demo user", align="center"] | ||
| * the *Add* button to add methods |
There was a problem hiding this comment.
The first Add button is not easy to find without indicating where methods should be.
Maybe instead of Click on :
The _Methods_ section at the bottom of the page is empty. To add methods :
* click on the *Add* button
* <other steps ...>
|
|
||
| * click on *Add methods* in the lower left of the technique details, to display the list of available methods, | ||
| * navigate to the *User* category. | ||
| * add a user description, with the xref:reference:reference:generic_methods.adoc#_user_fullname[User fullname method]: |
There was a problem hiding this comment.
this links looks broken due to the generic methods doc structure
There was a problem hiding this comment.
it's not broken on my laptop when i test it
There was a problem hiding this comment.
Not that it is actually broken, it does not lead to a 404 page, but the anchor #_user_fullname is not correctly resolved so on the page I need to search for the "User fullname method".
The issue looks like it was already there before
There was a problem hiding this comment.
Since the doc has just been removed in #1096, instead it should point to https://docs.rudder.io/techniques/8.3/user_fullname.html
There was a problem hiding this comment.
ahh yes i understand !
|
|
||
| And go to the bottom of the page, click on *Global configuration for all nodes* | ||
| (to apply it everywhere, we will see how it works later). | ||
| . click on *Target rules* |
There was a problem hiding this comment.
| . click on *Target rules* | |
| . click on the *Target rules* tab |
| And go to the bottom of the page, click on *Global configuration for all nodes* | ||
| (to apply it everywhere, we will see how it works later). | ||
| . click on *Target rules* | ||
| . choose *Global configuration for all nodes* |
There was a problem hiding this comment.
| . choose *Global configuration for all nodes* | |
| . check *Global configuration for all nodes* |
| header bar. Here you can search for any Rudder item (there is even a small query language!). | ||
| Let's change the policy mode. Click on: | ||
|
|
||
| image::./quicksearch.png["Quicksearch field", align="center"] | ||
| . menu *Directives* |
There was a problem hiding this comment.
Let's change the policy mode of the directive by updating it. Navigate to the directive page by clicking on :
* *Directives* in the menu
|
|
||
| And click on your directive to go to its configuration page. Now change policy mode to | ||
| default, and save. | ||
| Go back to the demo user directive. You can use the Directive page, or use the quick search field, in the |
There was a problem hiding this comment.
| Go back to the demo user directive. You can use the Directive page, or use the quick search field, in the | |
| Go back to the _demo_ user directive. You can use the Directive page, or use the quick search field, in the |
| ---- | ||
| rudder agent update | ||
| rudder agent run | ||
| ---- | ||
|
|
||
| You will see the actual modification happening, with a "repaired" state, and the demo user now exists |
There was a problem hiding this comment.
| You will see the actual modification happening, with a "repaired" state, and the demo user now exists | |
| You will see the actual modification happening, with a "repaired" state, and the _demo_ user now exists |
|
@clarktsiory Thanks for the review. I commited to resolve your comments. There is only the broken link. It is not broken when I test it. Were you saying that because you tested it ? Or just the look of it ? |
| @@ -15,8 +15,7 @@ The rest of the tutorial assumes you are | |||
| using this environment (you can also setup your own, | |||
| you will only have to substitute hostnames/IP addresses when necessary). | |||
|
|
|||
| This installation method is cross-platform, and you can use it on Linux, Microsoft Windows, Mac OS X | |||
There was a problem hiding this comment.
Why removing the mention of macOS here?
No description provided.