Skip to content

Notes/alerts in don't always render #453

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
Closed
sanscontext opened this issue Dec 12, 2019 · 7 comments · Fixed by #480
Closed

Notes/alerts in don't always render #453

sanscontext opened this issue Dec 12, 2019 · 7 comments · Fixed by #480

Comments

@sanscontext
Copy link
Contributor

sanscontext commented Dec 12, 2019 •
edited
Loading

What's wrong? Describe the what you're seeing

When I copy and paste in an "info" alert using the following syntax from the styleguide:

> info ""
> This is a paragraph showing information box. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Praesent condimentum dapibus imperdiet.

it doesn't render and instead looks like this:
image

I expect it to render like it does in the styleguide here in the same build. 🤔
image

Problem location

I was working in /src/connections/sources/catalog/cloud-apps/desk/index.md. For some reason this renders file in the styleguide but not here? 🤔

Mood (optional)
@imklau imklau assigned imklau and unassigned imklau Dec 17, 2019
@bart-krakowski bart-krakowski self-assigned this Dec 23, 2019
@bart-krakowski bart-krakowski mentioned this issue Dec 23, 2019
Merged
@sanscontext
Copy link
Contributor Author

Hey @bartlomiej-krakowski the diff in #480 looks really strange to me. Did you get it working? And did you figure out what was preventing it from working? It does appear to be broken in several different files.

@bart-krakowski
Copy link
Contributor

This particular file was CRLF as EOL mark. This is the only change I have made and it works for me.

@sanscontext
Copy link
Contributor Author

That's super strange. Is there an easy way to find and fix this in all the content files? Because if that's what's breaking it, it's going to be broken in a number of places. 🤔

@bart-krakowski
Copy link
Contributor

Laura,
please run following command in terminal (in folder of project):
find . -not -type d -exec file "{}" ";" | grep CRLF
Thats will find all files with CRLF.

@imklau
Copy link
Contributor

imklau commented Jan 14, 2020

Did you have a chance to take a look at this one Laura? Does Bart's solution fix the issue? @sanscontext

@sanscontext
Copy link
Contributor Author

It looks like it did! I'm wondering if it would be reasonable to write a test to check for these?

@sanscontext sanscontext reopened this Jan 22, 2020
@sanscontext
Copy link
Contributor Author

False alarm, #540 was the answer. (preceding single spaces also prevent it showing correctly.)

bot-docsteam added a commit that referenced this issue Jul 1, 2022
@bot-docsteam
Merge pull request #453 from segmentio/repo-sync
1661346 
repo sync
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

fix(): Fix alerts/notes rendering segmentio/segment-docs
3 participants
@sanscontext @imklau @bart-krakowski