Documentation contribution opportunities

[hugh (Hugh Lashbrooke)]

Discourse 문서는 관리자, 모더레이터, 사용자 및 시스템 관리자가 Discourse 사용과 사이트 관리에 대한 도움을 받을 수 있는 주요 위치입니다.

이 문서는 방대하고 많은 부분을 다루고 있지만, 아직 문서화되지 않은 일부 영역이 있습니다. 이는 Discourse 프로젝트의 이 중요한 부분을 개선하는 데 커뮤니티가 참여할 수 있는 훌륭한 기회입니다.

더 많은 사람들이 Discourse 문서 콘텐츠 생성에 참여하기를 바라며, 누구나 쉽게 이를 수행할 수 있도록 최대한 쉽게 만들고자 합니다. 이를 위해 아래에 새 문서 또는 개선된 문서가 필요하다고 판단한 Discourse 기능 또는 사용 사례 목록을 제공합니다.

문서 위치

신뢰 수준 2 이상인 누구나 #wiki에서 새로운 문서 주제를 만들 수 있습니다. 여기는 모든 커뮤니티 기여 문서 콘텐츠의 집합지입니다. 커뮤니티 위키의 주제가 관련性或 중요하다고 판단되면, 모든 공식 Discourse 문서의 집합지인 #documentation으로 이동될 수 있습니다. 이 과정에 대한 자세한 내용은 문서 정책을 참고하세요.

문서 기여자를 위한 배지

Wiki 카테고리에 새 주제를 생성하는 모든 사용자에게 자동으로 청동 Scribe 배지가 부여됩니다:

주제가 공식 Documentation 카테고리로 이동할 만큼 가치 있다고 판단되면, Discourse 팀의 누군가가 수동으로 이를 수행하고, 주제 콘텐츠에 원작자를 언급하며, 그들에게 은 Ghostwriter 배지를 부여합니다:

작성해야 할 문서

궁극적으로 Discourse의 모든 부분이 철저히 문서화되기를 원하지만, 가장 시급한 필요성이 있는 영역은 다음과 같습니다(취소선이 그어진 항목은 이 게시물이 처음 게시된 이후에 작성된 주제를 나타냅니다):

• 관리자를 위한 일반적인 시작 튜토리얼
• 사용자 정의 주제 리디렉션
• 다양한 사용자 수준이 수행할 수 있는 작업에 대한 설명
• 소셜 로그인 옵션
• 게시물 공지 (공식 문서)
• 신뢰 수준 작동 방식에 대한 추가 문서
• [x ] Discourse에 대한 좋은 기능 요청서를 작성하는 방법 (위키 주제)
• 이메일에 포함된 Discourse 마크다운 및 서식 기능이 어떻게 보이는지에 대한 참고 자료
• 사용자 상태 (위키 주제)
• 다크 모드 설명, 선택 방법 및 전환 활성화 방법 (위키 주제)
• 사용자 환경 설정 관리를 다루는 일반 문서 (위키 주제)
• Discourse에서 카테고리 및 위계 구조가 작동하는 방식을 설명하는 문서
• 주제 설정에 대한 일반 가이드
• 플러그인에 대한 일반 가이드 - 무엇인지, 어떻게 작동하는지, 어떻게 사용하는지
• 사용자 정의 홈페이지
• 기본 카테고리 및 주제 변경
• 게시물에서 이미지 그리드 사용 (위키 주제)
• 게시물 승인 설정 (위키 주제)

이 중 일부는 효과적으로 문서화하려면 여러 주제가 필요할 수 있습니다.

문서 작성 방법

Discourse 문서가 최대한 효과적이도록 하기 위해 이 콘텐츠를 작성하는 방법에 대한 스타일 가이드를 보유하고 있습니다. 모든 사람이 가이드를 따르는 것이 도움이 되겠지만, #wiki에 기여하는 경우 완전히 따르지 않더라도 문제가 되지 않습니다. #documentation으로 이동되는 주제는 필요에 따라 Discourse 직원이 스타일 가이드에 맞게 업데이트할 것입니다.

관심이 있으신가요?

#wiki에 들어가서 오늘 바로 문서화를 시작해 보세요. 이 중 어떤 것에 대해 논의하고 싶다면, 이 주제에 답글을 남겨 자유롭게 이야기해 주세요.

[Moin]

What about the existing topics? Like for example

@hugh

How to grant admin or moderator privileges to users

Promoting a User to Admin or Moderator Status

@hugh

How to write a good feature request for Discourse

Requesting new features for Discourse

[hugh (Hugh Lashbrooke)]

For this one:

@Moin

@hugh

How to write a good feature request for Discourse

Requesting new features for Discourse

The existing documentation talks about how to request new features, but not how to format a good request to make it more effective. We currently link to this page, but it would be good if we could have that kind of content on Meta instead.

And for this one:

@Moin

@hugh

How to grant admin or moderator privileges to users

Grant Admin or Moderator Privileges to a User

Good catch! I’ll remove that from the list in this topic

[ondrej]

@hugh

How to write a good feature request for Discourse

There is this topic covering feature requests already

Requesting new features for Discourse

This guide explains how to request new features for Discourse, check existing plans, and increase the chances of your feature request being prioritized. Required user level: Anyone can submit a feature request Got a great idea for a Discourse feature? That’s fantastic! Here’s how you can share it with the team effectively. Make sure your feature isn’t already made or planned Before submitting a new feature request, ensure it’s not already available or plann…

Unless it needs to look like this but for a feature request?

Writing an effective bug report

This is a guide for writing effective bug reports in Discourse to maximize the chances of getting bugs fixed. Required user level: Any can report a bug Writing a good bug report is essential to help the Discourse team fix issues efficiently. This guide will walk you through the steps and best practices to ensure your bug report is clear, concise, and actionable. Summary In this documentation, we’ll cover: The importance of providing reproducible steps and…

[HamMan2118]

@hugh

Post notices

Does this mean Staff Notice or something different?

[ondrej]

I assume this is a post notice since its in the title

Post notices for first-time and returning users

To encourage kindness towards users who are posting for the first time or may not have posted in a while we’ve created a new feature that calls special attention to these new/returning users. These banners are visible to other users, but not the poster they apply to… and by default are only visible to community members who have been active enough to achieve Trust Level 2. Here’s what they look like: [image] [image] How can I configure this feature? Admins can adjust these options in their…

Staff notices are basically the same I guess?

[hugh (Hugh Lashbrooke)]

@ondrej

Unless it needs to look like this but for a feature request?

Yeah that’s what we’re looking for there

@HamMan2118

@hugh

Post notices

Does this mean Staff Notice or something different?

As @ondrej linked to, post notices are what are outlined in this announcement. We have that announcement topic, but not actual documentation about it.

[Heliosurge (Dan DeMontmorency)]

I Hugh, this is great idea.

I have been meaning to present an idea for the community wiki to have some kind of tag for say forum templates.

The idea I have for this. Is often we have folks asking about using discourse for things like a Support Forum, Learning Platform etc.. Even sometimes more obscure uses like a Table Top RPG.

Collecting content from topics like those & even thinking of various uses. We could create a new resource with a master Topic used as an index.

• Support Forum Templates
• Learning Platform Templates

These Topics can house Hosted by Discourse, Communique(so?) etc.. with recommended plugins & Theme components etc . As well as a post for Self-hosted.

Hosted templates would focus on the plugins & reference what plans are needed for a particular plugin for use.

With tips & tricks and even point folks to the Marketplace if they need a custom layout, plugin, etc..

[NateDhaliwal]

@hugh

User statuses

Made:

Custom User Statuses

Summary This document covers: What a Custom User Status Is How to add, modify, and remove a custom user status. Custom User Status Description A Custom User Status is a feature where users can set a custom status and icon to appear in their profile and next to their avatar at posts. This can be used, as a member, to let the community know if you are unavailable, on vacation, or want to share how you are feeling. A custom user status appears like this in a post: [Username "andrei" with a pa…

[hugh (Hugh Lashbrooke)]

I saw that Great to see these coming in!

[NateDhaliwal]

Working on the one for dark mode.

[NateDhaliwal]

These guides have aleeady been made but not yet ticked off:

@hugh

User statuses

Custom User Statuses

Summary This document covers: What a Custom User Status Is How to add, modify, and remove a custom user status. Custom User Status Description A Custom User Status is a feature where users can set a custom status and icon to appear in their profile and next to their avatar at posts. This can be used, as a member, to let the community know if you are unavailable, on vacation, or want to share how you are feeling. A custom user status appears like this in a post: [Username "andrei" with a pa…

@hugh

Using image grids in posts

Image Grids

This guide explains what Image Grids are and how to apply them in your posts. Required user level: Trust Level 0 Summary This document covers: Description of image grids How they can be applied in posts and how to modify them Basic Layout of image grids Image Grids Description An image grid places all of the images in your post into a neat, organized grid - rather than in a list. Below is an example of an image grid. [Delta A321-200 Landing in Washingt…

@hugh

Custom homepages

This one is a bit blurry. Does it refer to custom homepage content? If so, then maybe Add custom content that only appears on your homepage. Otherwise… it hasn’t been written yet.

[hugh (Hugh Lashbrooke)]

Thanks for circling back here - I have updated the OP with these links.

@NateDhaliwal

This one is a bit blurry. Does it refer to custom homepage content?

This is a fairly niche thing and refers to creating a custom homepage, so not really something that most Discourse admins will be using. It’s not a primary feature, as it isn’t something that is fully polished at this stage.