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.

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

Improve GCP wodle options descriptions #6570

Merged
merged 6 commits into from
Oct 13, 2023

Conversation

GGP1
Copy link
Member

@GGP1 GGP1 commented Sep 28, 2023

Description

Closes #5699.

Improves the GCP wodle gcp-bucket and gcp-pubsub configuration options descriptions.

Checks

Docs building

  • Compiles without warnings.
build
Running Sphinx v7.0.1
loading translations [en-US]... not available for built-in messages
loading pickled environment... done
building [mo]: targets for 0 po files that are out of date
writing output...
building [html]: targets for 1 source files that are out of date
updating environment: 0 added, 1 changed, 0 removed
reading sources... [100%] user-manual/reference/ossec-conf/gcp-bucket                                      	 
Copying static files for wazuh-doc-images...[100%] img/loading.gif                                         	 
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] user-manual/reference/ossec-conf/index                                            	 
generating indices... done
writing additional pages... not_found moved-content search done
copying static files... done
copying extra files... done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded.

The HTML pages are in home/python/build/html.
[sphinx-autobuild] Serving on http://0.0.0.0:8000/
[I 231002 19:40:31 handlers:92] Reload 1 waiters: /home/python/docs/user-manual/reference/ossec-conf/gcp-bucket.rst
[I 231002 19:40:31 handlers:135] Browser Connected: http://0.0.0.0:8000/user-manual/reference/ossec-conf/gcp-bucket.html

Code formatting and web optimization

  • Uses three spaces indentation.
  • Adds or updates meta descriptions accordingly.
  • Updates the redirects.js script if necessary (check this guide).

Writing style

  • Uses present tense, active voice, and semi-formal registry.
  • Uses short, simple sentences.
  • Uses bold for user interface elements, italics for key terms or emphasis, and code font for Bash commands, file names, REST paths, and code.

@GGP1 GGP1 self-assigned this Sep 28, 2023
@GGP1 GGP1 linked an issue Sep 28, 2023 that may be closed by this pull request
3 tasks
@fdalmaup fdalmaup self-requested a review September 29, 2023 20:02
Copy link
Member

@fdalmaup fdalmaup left a comment

Choose a reason for hiding this comment

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

We could add tables like the ones that the aws-s3 module has to summarize the available options and if they are mandatory or not (e.g. the one for the bucket's options).

Also, we should check if these changes will be part of release 4.6.0 or not.

@GGP1 GGP1 force-pushed the fix/5699-update-gcp-configurations branch from fce26ef to 307d94b Compare October 2, 2023 13:03
Copy link
Member

@fdalmaup fdalmaup left a comment

Choose a reason for hiding this comment

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

The changes are correct, but the format should be modified to have the different bucket options in a hierarchy level lower than the Bucket options title, thus also removing the bucket\ prefix for each option.

image

@fdalmaup fdalmaup self-requested a review October 3, 2023 12:39
Copy link
Member

@fdalmaup fdalmaup left a comment

Choose a reason for hiding this comment

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

LGTM!

@javimed javimed added level/task Task issue type/bug Bug issue labels Oct 9, 2023
@javimed
Copy link
Member

javimed commented Oct 11, 2023

@GGP1 what if we made changes to get the result in the image below? Look into the content and the right sidebar as well. You'll see further changes in structure and an additional table for the attributes and the clarification ... (attribute) in the type entry title. Please let me know what you and team think of these suggestions which I can commit, modify, or even drop. Thank you.

imagen

@GGP1
Copy link
Member Author

GGP1 commented Oct 11, 2023

@javimed that looks better in my opinion. Feel free to commit the changes you consider necessary.

@javimed
Copy link
Member

javimed commented Oct 11, 2023

Ok, I added a few changes. Let me know if it's ok and if we're good to merge this PR, @Selutario @fdalmaup

@s-ocando s-ocando merged commit 299c6af into 4.6.0 Oct 13, 2023
@s-ocando s-ocando deleted the fix/5699-update-gcp-configurations branch October 13, 2023 08:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
level/task Task issue type/bug Bug issue
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Update gcp-bucket and gcp-pubsub reference pages
5 participants