Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

ENT-10940: file and command components in examples & web ui sections #3183

Merged
merged 6 commits into from
Jan 15, 2024
Merged

ENT-10940: file and command components in examples & web ui sections #3183

merged 6 commits into from
Jan 15, 2024

Conversation

mineralsfree
Copy link
Contributor

No description provided.

@mineralsfree
new file and command component usage in web UI section
18b4d66 
Ticket: ENT-10940
Changelog: None
Signed-off-by: Mikita Pilinka <[email protected]>
@mineralsfree mineralsfree added the WIP work in progress label Jan 10, 2024
@mineralsfree
Copy link
Contributor Author

@cf-bottom jenkins, please

@cf-bottom
Copy link

Sure, I triggered a build:

Build Status

Jenkins: https://ci.cfengine.com/job/fast-build-and-deploy-docs-master/492/

Documentation: http://buildcache.cfengine.com/packages/build-documentation-pr/jenkins-fast-build-and-deploy-docs-master-492/output/_site/

@mineralsfree
Copy link
Contributor Author

@cf-bottom jenkins, please

@cf-bottom
Copy link

Alright, I triggered a build:

Build Status

Jenkins: https://ci.cfengine.com/job/fast-build-and-deploy-docs-master/493/

Documentation: http://buildcache.cfengine.com/packages/build-documentation-pr/jenkins-fast-build-and-deploy-docs-master-493/output/_site/

@mineralsfree
Copy link
Contributor Author

@cf-bottom jenkins, please

@cf-bottom
Copy link

Sure, I triggered a build:

Build Status

Jenkins: https://ci.cfengine.com/job/fast-build-and-deploy-docs-master/494/

Documentation: http://buildcache.cfengine.com/packages/build-documentation-pr/jenkins-fast-build-and-deploy-docs-master-494/output/_site/

olehermanse
olehermanse reviewed Jan 10, 2024
View reviewed changes
examples.markdown Outdated
/var/cfengine/bin/cf-agent --no-lock --file ./hello_world.cf --bundlesequence hello_world
```

This command instructs CFEngine to ignore [locks][Controlling frequency], load
the `hello_world.cf` policy, and activate the `hello_world` bundle. See the output below:

```console
```command
# /var/cfengine/bin/cf-agent --no-lock --file ./hello_world.cf --bundlesequence hello_world
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# /var/cfengine/bin/cf-agent --no-lock --file ./hello_world.cf --bundlesequence hello_world
/var/cfengine/bin/cf-agent --no-lock --file ./hello_world.cf --bundlesequence hello_world

olehermanse
olehermanse reviewed Jan 10, 2024
View reviewed changes
examples/example-snippets/promise-patterns/example_edit_motd.markdown Outdated
```console
root@debian8:~/core/examples# cf-agent -KIf ./mustache_template_motd.cf; cat /etc/motd
```command
cf-agent -KIf ./mustache_template_motd.cf; cat /etc/motd
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
cf-agent -KIf ./mustache_template_motd.cf; cat /etc/motd
cf-agent -KIf ./mustache_template_motd.cf; cat /etc/motd

olehermanse
olehermanse reviewed Jan 10, 2024
View reviewed changes
examples/example-snippets/promise-patterns/example_edit_motd.markdown Outdated
root@debian8:~/core/examples# cf-agent -KIf ./mustache_template_motd.cf; cat /etc/motd
```command
cf-agent -KIf ./mustache_template_motd.cf; cat /etc/motd
```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

deindent this by removing a space

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mineralsfree looks like you fixed the other things I commented on, but this one remains

@mineralsfree mineralsfree force-pushed the ENT-10940 branch 2 times, most recently from 32e6009 to 4016968 Compare January 11, 2024 13:57
@mineralsfree
Copy link
Contributor Author

@cf-bottom jenkins, please

@cf-bottom
Copy link

Alright, I triggered a build:

Build Status

Jenkins: https://ci.cfengine.com/job/fast-build-and-deploy-docs-master/498/

Documentation: http://buildcache.cfengine.com/packages/build-documentation-pr/jenkins-fast-build-and-deploy-docs-master-498/output/_site/

@mineralsfree
new file and command component usage in examples and tutorials section
4637f16 
Ticket: ENT-10940
Changelog: None
Signed-off-by: Mikita Pilinka <[email protected]>
@olehermanse olehermanse self-requested a review January 15, 2024 12:20
@mineralsfree mineralsfree removed the WIP work in progress label Jan 15, 2024
olehermanse
olehermanse requested changes Jan 15, 2024
View reviewed changes
Copy link
Member

@olehermanse olehermanse left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like you need to ensure there is a blank line before the command markdown for it to work correctly. Added some suggestions, there are more further down.

examples/example-snippets/promise-patterns/example_aborting_execution.markdown Show resolved Hide resolved
examples/example-snippets/promise-patterns/example_aborting_execution.markdown Show resolved Hide resolved
examples/example-snippets/promise-patterns/example_change_detection.markdown Show resolved Hide resolved
examples/example-snippets/promise-patterns/example_enable_service.markdown Show resolved Hide resolved
examples/example-snippets/promise-patterns/example_enable_service.markdown Show resolved Hide resolved
examples/example-snippets/promise-patterns/example_enable_service.markdown Show resolved Hide resolved
examples/example-snippets/promise-patterns/example_enable_service.markdown Show resolved Hide resolved
examples/example-snippets/promise-patterns/example_enable_service.markdown Show resolved Hide resolved
@olehermanse
markdowner.py: Add double newline between consecutive codeblocks wher…
8e0c0a1 
…e second is command component

Signed-off-by: Ole Herman Schumacher Elgesem <[email protected]>
@olehermanse
Ran markdowner.py to apply the new formatting rule
5f46edc 
Signed-off-by: Ole Herman Schumacher Elgesem <[email protected]>
@olehermanse olehermanse self-requested a review January 15, 2024 14:30
@olehermanse
Copy link
Member

@cf-bottom jenkins, please :)

@cf-bottom
Copy link

Alright, I triggered a build:

Build Status

Jenkins: https://ci.cfengine.com/job/fast-build-and-deploy-docs-master/503/

Documentation: http://buildcache.cfengine.com/packages/build-documentation-pr/jenkins-fast-build-and-deploy-docs-master-503/output/_site/

@olehermanse olehermanse merged commit fc950ff into cfengine:master Jan 15, 2024
2 checks passed
@olehermanse olehermanse changed the title Ent 10940: file and command components in examples & web ui sections ENT-10940: file and command components in examples & web ui sections Jan 15, 2024
@olehermanse
Copy link
Member

Cherry-pick: #3204

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@olehermanse olehermanse olehermanse approved these changes

Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@mineralsfree @cf-bottom @olehermanse