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

Convert Designer section to RST #266

Open
wants to merge 23 commits into
base: main
Choose a base branch
from
Open

Conversation

adiati98
Copy link

Description

This PR converts the Designer page into RST, including:

  • Add new link files to the links folder
  • Update the copy to address Vale's warnings and suggestions where applicable and possible

Link Issue

Closes #265

@favour-chibueze
Copy link
Contributor

@adiati98 We still have vale errors to fix in this PR. Please take a look at them

@adiati98
Copy link
Author

adiati98 commented Feb 18, 2025

@favour-chibueze thank you for the review!

Yes, I'm aware of the Vale errors and actually waiting for your suggestions.

Vale Warnings

There are 2 Vale suggestions that caused warnings here:

  1. Passive sentences

    There are a couple of these warnings. These sentences are quite tricky to transform into active sentences while keeping the clarity. But I'll take a closer look again and see how I can fix them. It'd be great if I can have second eyes here though!🙂

  2. Mautic's FeatureList suggestions

    The Vale asks if some of words are part of Mautic's feature list and suggests to change the first letter into capital if they are. Here is an example. The sentence in line 32:

    Design tasks are primarily cross-project rather than specific to a team. You're most welcome to join whatever channels that interest you.

    Suggestion from Vale:

    [Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Channels' instead of 'channels'
    

    The "channels" here is referring to Slack channels and not a Mautic feature.

Suggested Solutions

I'm thinking of below ideas for the FeatureList suggestions and would love to have your thoughts:

  1. Wrap all sentences that cause warnings in .. vale off and .. vale on

    However, my question is: would this be ideal?

  2. The FeatureList warning happens for all words listed in the Mautic's FeatureList. Would adding these words in the accept.txt override and solve the problem?

    I'm not on my computer atm, but I can try this as soon as I'm back. However, if this can fix the warning, I'm not sure if we want to override anything in the list as the features are more important.

  3. I've looked at previous PRs. And most PRs about converting to RST that got merged also had the FeatureList warnings (i.e. PR Added the overview & community council pages. #246, Product-Team-Conversion #247, etc.). Maybe we want to ignore these warnings as those PRs?

Thank you in advance! ✨

@adiati98
Copy link
Author

@favour-chibueze I've made changes to address the passive voice warnings.

Kindly review the copy of this page as there are plenty of wording changes to address the warnings.
Do let me know if I need to fix anything.

Thank you. 🙂

@adiati98
Copy link
Author

@favour-chibueze following up suggestion no. 2 in my comment above, I've tested it out and want to let you know how it went.


  1. I added a word "user" to the accept.txt file to address a suggestion warning for line 19.

    - Contributing to Strategic Initiatives by designing the user experience for new features

    user-suggestion

  2. It fixed the warning for line 19, but created a new error warning for line 23.

    - Joining the User Experience Tiger Team

    user-error-designer

    Doing so also created new error warnings for other files as example below:

    user-error-contributing-docs


Conclusion: This solution is not an option because it will create new errors.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Convert Designer section to RST
2 participants